JOpenstreetmapChangesets
Extends \JOpenstreetmapObjectOpenstreetmap API Changesets class for the Joomla Platform
since |
3.2.0 |
---|---|
deprecated |
4.0 Use the |
package |
Joomla.Platform |
Methods
__construct
Constructor
__construct(\Joomla\Registry\Registry &$options = null, \JHttp $client = null, \JOpenstreetmapOauth $oauth = null)
since |
3.2.0 |
---|
Arguments
- $options
- $client
\JHttp
The HTTP client object.- $oauth
\JOpenstreetmapOauth
Openstreetmap oauth client
closeChangeset
Method to close a changeset
closeChangeset(integer $id) : void
since |
3.2.0 |
---|
Arguments
- $id
integer
identifier of the changeset
createChangeset
Method to create a changeset
createChangeset(array $changesets = array()) : array
since |
3.2.0 |
---|
Arguments
- $changesets
array
Array which contains changeset data
Response
array
The XML response
diffUploadChangeset
Method to upload a diff to a changeset
diffUploadChangeset(string $xml, integer $id) : array
since |
3.2.0 |
---|
Arguments
- $xml
string
Diff data to upload- $id
integer
Identifier of the changeset
Response
array
The XML response of result
downloadChangeset
Method to download a changeset
downloadChangeset(integer $id) : array
since |
3.2.0 |
---|
Arguments
- $id
integer
Identifier of the changeset
Response
array
The XML response of requested changeset
expandBBoxChangeset
Method to expand the bounding box of a changeset
expandBBoxChangeset(integer $id, array $nodes) : array
since |
3.2.0 |
---|
Arguments
- $id
integer
Identifier of the changeset- $nodes
array
List of lat lon about nodes
Response
array
The XML response of changed changeset
getOption
Get an option from the JOpenstreetmapObject instance.
getOption(string $key) : mixed
since |
3.2.0 |
---|
Arguments
- $key
string
The name of the option to get.
Response
mixed
The option value.
queryChangeset
Method to query on changesets
queryChangeset(string $param) : array
since |
3.2.0 |
---|
Arguments
- $param
string
Parameters for query
Response
array
The XML response
readChangeset
Method to read a changeset
readChangeset(integer $id) : array
since |
3.2.0 |
---|
Arguments
- $id
integer
identifier of the changeset
Response
array
The XML response about a changeset
sendRequest
Method to send the request which does not require authentication.
sendRequest(string $path, string $method = 'GET', array $headers = array(), mixed $data = '') : \SimpleXMLElement
since |
3.2.0 |
---|---|
throws |
|
Arguments
- $path
string
The path of the request to make- $method
string
The request method.- $headers
array
The headers passed in the request.- $data
mixed
Either an associative array or a string to be sent with the post request.
Response
\SimpleXMLElement
The XML response
setOption
Set an option for the JOpenstreetmapObject instance.
setOption(string $key, mixed $value) : \JOpenstreetmapObject
since |
3.2.0 |
---|
Arguments
- $key
string
The name of the option to set.- $value
mixed
The option value to set.
Response
\JOpenstreetmapObject
This object for method chaining.
updateChangeset
Method to update a changeset
updateChangeset(integer $id, array $tags = array()) : array
since |
3.2.0 |
---|
Arguments
- $id
integer
Identifier of the changeset- $tags
array
Array of tags to update
Response
array
The XML response of updated changeset
Properties
options
Options for the Openstreetmap object.
client
The HTTP client object to use in sending HTTP requests.
since |
3.2.0 |
---|
Type(s)
\JHttp