JOpenstreetmapElements
Extends \JOpenstreetmapObjectOpenstreetmap API Elements 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
createNode
Method to create a node
createNode(integer $changeset, float $latitude, float $longitude, array $tags) : array
| since |
3.2.0 |
|---|
Arguments
- $changeset
integerChangeset id- $latitude
floatLatitude of the node- $longitude
floatLongitude of the node- $tags
arrayArray of tags for a node
Response
arrayThe XML response
createRelation
Method to create a relation
createRelation(integer $changeset, array $tags, array $members) : array
| since |
3.2.0 |
|---|
Arguments
- $changeset
integerChangeset id- $tags
arrayArray of tags for a relation- $members
arrayArray of members for a relation eg: $members = array(array("type"=>"node", "role"=>"stop", "ref"=>"123"), array("type"=>"way", "ref"=>"123"))
Response
arrayThe XML response
createWay
Method to create a way
createWay(integer $changeset, array $tags, array $nds) : array
| since |
3.2.0 |
|---|
Arguments
- $changeset
integerChangeset id- $tags
arrayArray of tags for a way- $nds
arrayNode ids to refer
Response
arrayThe XML response
deleteElement
Method to delete an element [node|way|relation]
deleteElement(string $element, integer $id, integer $version, integer $changeset, float $latitude = null, float $longitude = null) : array
| since |
3.2.0 |
|---|---|
| throws |
|
Arguments
- $element
string[node|way|relation]- $id
integerElement identifier- $version
integerElement version- $changeset
integerChangeset identifier- $latitude
floatLatitude of the element- $longitude
floatLongitude of the element
Response
arrayThe XML response
fullElement
Method to get full information about an element [way|relation]
fullElement(string $element, integer $id) : array
| since |
3.2.0 |
|---|---|
| throws |
|
Arguments
- $element
string[way|relation]- $id
integerIdentifier
Response
arrayThe XML response
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.
historyOfElement
Method to get history of an element [node|way|relation]
historyOfElement(string $element, integer $id) : array
| since |
3.2.0 |
|---|---|
| throws |
|
Arguments
- $element
string[node|way|relation]- $id
integerElement identifier
Response
arrayThe XML response
multiFetchElements
Method to get data about multiple ids of an element [node|way|relation]
multiFetchElements(string $element, string $params) : array
| since |
3.2.0 |
|---|---|
| throws |
|
Arguments
- $element
string[nodes|ways|relations] - use plural word- $params
stringComma separated list of ids belonging to type $element
Response
arrayThe XML response
readElement
Method to read an element [node|way|relation]
readElement(string $element, integer $id) : array
| since |
3.2.0 |
|---|---|
| throws |
|
Arguments
- $element
string[node|way|relation]- $id
integerElement identifier
Response
arrayThe XML response
redaction
Method used by the DWG to hide old versions of elements containing data privacy or copyright infringements
redaction(string $element, integer $id, integer $version, integer $redaction_id) : array
| since |
3.2.0 |
|---|---|
| throws |
|
Arguments
- $element
string[node|way|relation]- $id
integerElement identifier- $version
integerElement version- $redaction_id
integerRedaction id
Response
arrayThe xml response
relationsForElement
Method to get relations for an Element [node|way|relation]
relationsForElement(string $element, integer $id) : array
| since |
3.2.0 |
|---|---|
| throws |
|
Arguments
- $element
string[node|way|relation]- $id
integerElement identifier
Response
arrayThe XML response
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.
updateElement
Method to update an Element [node|way|relation]
updateElement(string $element, string $xml, integer $id) : array
| since |
3.2.0 |
|---|---|
| throws |
|
Arguments
- $element
string[node|way|relation]- $xml
stringFull reperentation of the element with a version number- $id
integerElement identifier
Response
arrayThe xml response
versionOfElement
Method to get details about a version of an element [node|way|relation]
versionOfElement(string $element, integer $id, integer $version) : array
| since |
3.2.0 |
|---|---|
| throws |
|
Arguments
- $element
string[node|way|relation]- $id
integerElement identifier- $version
integerElement version
Response
arrayThe XML response
waysForNode
Method to get ways for a Node element
waysForNode(integer $id) : array
| since |
3.2.0 |
|---|
Arguments
- $id
integerNode identifier
Response
arrayThe XML response
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