Class JOpenstreetmapElements

Description
Description | Vars | Methods (details)

Openstreetmap API Elements class for the Joomla Platform

  • since: 13.1

Located in /libraries/joomla/openstreetmap/elements.php (line 19) 

JOpenstreetmapObject
   |
   --JOpenstreetmapElements
Method Summary
Description | Vars | Methods (details)
array createNode (integer $changeset, float $latitude, float $longitude, arary $tags)
array createRelation (integer $changeset, array $tags, array $members)
array createWay (integer $changeset, array $tags, array $nds)
array deleteElement (string $element, integer $id, integer $version, integer $changeset, [float $latitude = null], [float $longitude = null])
array fullElement (string $element, integer $id)
array historyOfElement (string $element, integer $id)
array multiFetchElements (string $element, string $params)
array readElement (string $element, integer $id)
array redaction (string $element, integer $id, integer $version, integer $redaction_id)
array relationsForElement (string $element, integer $id)
array updateElement (string $element, string $xml, integer $id)
array versionOfElement (string $element, integer $id, integer $version)
array waysForNode (integer $id)
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from JOpenstreetmapObject

JOpenstreetmapObject::$client
 JOpenstreetmapObject::$oauth
 JOpenstreetmapObject::$options
Methods
Description | Vars Methods (details)
createNode (line 33)

Method to create a node

  • return: The XML response
  • since: 13.1
  • access: public
array createNode (integer $changeset, float $latitude, float $longitude, arary $tags)
  • integer $changeset: Changeset id
  • float $latitude: Latitude of the node
  • float $longitude: Longitude of the node
  • arary $tags: Array of tags for a node
createRelation (line 149)

Method to create a relation

  • return: The XML response
  • since: 13.1
  • access: public
array createRelation (integer $changeset, array $tags, array $members)
  • integer $changeset: Changeset id
  • array $tags: Array of tags for a relation
  • array $members: Array of members for a relation eg: $members = array(array("type"=>"node", "role"=>"stop", "ref"=>"123"), array("type"=>"way", "ref"=>"123"))
createWay (line 85)

Method to create a way

  • return: The XML response
  • since: 13.1
  • access: public
array createWay (integer $changeset, array $tags, array $nds)
  • integer $changeset: Changeset id
  • array $tags: Array of tags for a way
  • array $nds: Node ids to refer
deleteElement (line 294)

Method to delete an element [node|way|relation]

  • return: The XML response
  • since: 13.1
  • throws: DomainException
  • access: public
array deleteElement (string $element, integer $id, integer $version, integer $changeset, [float $latitude = null], [float $longitude = null])
  • string $element: [node|way|relation]
  • integer $id: Element identifier
  • integer $version: Element version
  • integer $changeset: Changeset identifier
  • float $latitude: Latitude of the element
  • float $longitude: Longitude of the element
fullElement (line 492)

Method to get full information about an element [way|relation]

  • return: The XML response
  • since: 13.1
  • throws: DomainException
  • access: public
array fullElement (string $element, integer $id)
  • string $element: [way|relation]
  • integer $id: Identifier
historyOfElement (line 345)

Method to get history of an element [node|way|relation]

  • return: The XML response
  • since: 13.1
  • throws: DomainException
  • access: public
array historyOfElement (string $element, integer $id)
  • string $element: [node|way|relation]
  • integer $id: Element identifier
multiFetchElements (line 406)

Method to get data about multiple ids of an element [node|way|relation]

  • return: The XML response
  • since: 13.1
  • throws: DomainException
  • access: public
array multiFetchElements (string $element, string $params)
  • string $element: [nodes|ways|relations] - use plural word
  • string $params: Comma separated list of ids belonging to type $element
readElement (line 220)

Method to read an element [node|way|relation]

  • return: The XML response
  • since: 13.1
  • throws: DomainException
  • access: public
array readElement (string $element, integer $id)
  • string $element: [node|way|relation]
  • integer $id: Element identifier
redaction (line 524)

Method used by the DWG to hide old versions of elements containing data privacy or copyright infringements

  • return: The xml response
  • since: 13.1
  • throws: DomainException
  • access: public
array redaction (string $element, integer $id, integer $version, integer $redaction_id)
  • string $element: [node|way|relation]
  • integer $id: Element identifier
  • integer $version: Element version
  • integer $redaction_id: Redaction id
relationsForElement (line 439)

Method to get relations for an Element [node|way|relation]

  • return: The XML response
  • since: 13.1
  • throws: DomainException
  • access: public
array relationsForElement (string $element, integer $id)
  • string $element: [node|way|relation]
  • integer $id: Element identifier
updateElement (line 251)

Method to update an Element [node|way|relation]

  • return: The xml response
  • since: 13.1
  • throws: DomainException
  • access: public
array updateElement (string $element, string $xml, integer $id)
  • string $element: [node|way|relation]
  • string $xml: Full reperentation of the element with a version number
  • integer $id: Element identifier
versionOfElement (line 376)

Method to get details about a version of an element [node|way|relation]

  • return: The XML response
  • since: 13.1
  • throws: DomainException
  • access: public
array versionOfElement (string $element, integer $id, integer $version)
  • string $element: [node|way|relation]
  • integer $id: Element identifier
  • integer $version: Element version
waysForNode (line 467)

Method to get ways for a Node element

  • return: The XML response
  • since: 13.1
  • access: public
array waysForNode (integer $id)
  • integer $id: Node identifier

Inherited Methods

Inherited From JOpenstreetmapObject

JOpenstreetmapObject::__construct()
JOpenstreetmapObject::getOption()
JOpenstreetmapObject::sendRequest()
JOpenstreetmapObject::setOption()

Documentation generated on Tue, 19 Nov 2013 15:02:24 +0100 by phpDocumentor 1.4.3