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
\JHttpThe HTTP client object.- $oauth
\JOpenstreetmapOauthOpenstreetmap oauth client
closeChangeset
Method to close a changeset
closeChangeset(integer $id) : void
| since |
3.2.0 |
|---|
Arguments
- $id
integeridentifier of the changeset
createChangeset
Method to create a changeset
createChangeset(array $changesets = array()) : array
| since |
3.2.0 |
|---|
Arguments
- $changesets
arrayArray which contains changeset data
Response
arrayThe XML response
diffUploadChangeset
Method to upload a diff to a changeset
diffUploadChangeset(string $xml, integer $id) : array
| since |
3.2.0 |
|---|
Arguments
- $xml
stringDiff data to upload- $id
integerIdentifier of the changeset
Response
arrayThe XML response of result
downloadChangeset
Method to download a changeset
downloadChangeset(integer $id) : array
| since |
3.2.0 |
|---|
Arguments
- $id
integerIdentifier of the changeset
Response
arrayThe 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
integerIdentifier of the changeset- $nodes
arrayList of lat lon about nodes
Response
arrayThe XML response of changed changeset
getOption
Get an option from the JOpenstreetmapObject instance.
getOption(string $key) : mixed
| since |
3.2.0 |
|---|
Arguments
- $key
stringThe name of the option to get.
Response
mixedThe option value.
queryChangeset
Method to query on changesets
queryChangeset(string $param) : array
| since |
3.2.0 |
|---|
Arguments
- $param
stringParameters for query
Response
arrayThe XML response
readChangeset
Method to read a changeset
readChangeset(integer $id) : array
| since |
3.2.0 |
|---|
Arguments
- $id
integeridentifier of the changeset
Response
arrayThe 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
stringThe path of the request to make- $method
stringThe request method.- $headers
arrayThe headers passed in the request.- $data
mixedEither an associative array or a string to be sent with the post request.
Response
\SimpleXMLElementThe XML response
setOption
Set an option for the JOpenstreetmapObject instance.
setOption(string $key, mixed $value) : \JOpenstreetmapObject
| since |
3.2.0 |
|---|
Arguments
- $key
stringThe name of the option to set.- $value
mixedThe option value to set.
Response
\JOpenstreetmapObjectThis object for method chaining.
updateChangeset
Method to update a changeset
updateChangeset(integer $id, array $tags = array()) : array
| since |
3.2.0 |
|---|
Arguments
- $id
integerIdentifier of the changeset- $tags
arrayArray of tags to update
Response
arrayThe 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