Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JOpenstreetmapElements
+ Graphe d'héritage de JOpenstreetmapElements:

Fonctions membres publiques

 createNode ($changeset, $latitude, $longitude, $tags)
 
 createWay ($changeset, $tags, $nds)
 
 createRelation ($changeset, $tags, $members)
 
 readElement ($element, $id)
 
 updateElement ($element, $xml, $id)
 
 deleteElement ($element, $id, $version, $changeset, $latitude=null, $longitude=null)
 
 historyOfElement ($element, $id)
 
 versionOfElement ($element, $id, $version)
 
 multiFetchElements ($element, $params)
 
 relationsForElement ($element, $id)
 
 waysForNode ($id)
 
 fullElement ($element, $id)
 
 redaction ($element, $id, $version, $redactionId)
 
- Fonctions membres publiques hérités de JOpenstreetmapObject
 __construct (Registry &$options=null, JHttp $client=null, JOpenstreetmapOauth $oauth=null)
 
 getOption ($key)
 
 setOption ($key, $value)
 
 sendRequest ($path, $method='GET', $headers=array(), $data='')
 

Membres hérités additionnels

- Attributs protégés hérités de JOpenstreetmapObject
 $options
 
 $client
 
 $oauth
 

Description détaillée

Openstreetmap API Elements class for the Joomla Platform

Depuis
3.2.0
Obsolète:
4.0 Use the joomla/openstreetmap package via Composer instead

Documentation des fonctions membres

◆ createNode()

createNode (   $changeset,
  $latitude,
  $longitude,
  $tags 
)

Method to create a node

Paramètres
integer$changesetChangeset id
float$latitudeLatitude of the node
float$longitudeLongitude of the node
array$tagsArray of tags for a node
Renvoie
array The XML response
Depuis
3.2.0

Références $base, $key, $parameters, $path, et $value.

◆ createRelation()

createRelation (   $changeset,
  $tags,
  $members 
)

Method to create a relation

Paramètres
integer$changesetChangeset id
array$tagsArray of tags for a relation
array$membersArray of members for a relation eg: $members = array(array("type"=>"node", "role"=>"stop", "ref"=>"123"), array("type"=>"way", "ref"=>"123"))
Renvoie
array The XML response
Depuis
3.2.0

Références $base, $key, $member, $parameters, $path, $value, et elseif.

◆ createWay()

createWay (   $changeset,
  $tags,
  $nds 
)

Method to create a way

Paramètres
integer$changesetChangeset id
array$tagsArray of tags for a way
array$ndsNode ids to refer
Renvoie
array The XML response
Depuis
3.2.0

Références $base, $key, $parameters, $path, et $value.

◆ deleteElement()

deleteElement (   $element,
  $id,
  $version,
  $changeset,
  $latitude = null,
  $longitude = null 
)

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

Paramètres
string$element[node|way|relation]
integer$idElement identifier
integer$versionElement version
integer$changesetChangeset identifier
float$latitudeLatitude of the element
float$longitudeLongitude of the element
Renvoie
array The XML response
Depuis
3.2.0
Exceptions
DomainException

Références $base, $id, $parameters, $path, et $version.

◆ fullElement()

fullElement (   $element,
  $id 
)

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

Paramètres
string$element[way|relation]
integer$idIdentifier
Renvoie
array The XML response
Depuis
3.2.0
Exceptions
DomainException

Références $base, $id, et $path.

◆ historyOfElement()

historyOfElement (   $element,
  $id 
)

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

Paramètres
string$element[node|way|relation]
integer$idElement identifier
Renvoie
array The XML response
Depuis
3.2.0
Exceptions
DomainException

Références $base, $id, et $path.

◆ multiFetchElements()

multiFetchElements (   $element,
  $params 
)

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

Paramètres
string$element[nodes|ways|relations] - use plural word
string$paramsComma separated list of ids belonging to type $element
Renvoie
array The XML response
Depuis
3.2.0
Exceptions
DomainException

Références $base, $params, et $path.

◆ readElement()

readElement (   $element,
  $id 
)

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

Paramètres
string$element[node|way|relation]
integer$idElement identifier
Renvoie
array The XML response
Depuis
3.2.0
Exceptions
DomainException

Références $base, $id, et $path.

◆ redaction()

redaction (   $element,
  $id,
  $version,
  $redactionId 
)

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

Paramètres
string$element[node|way|relation]
integer$idElement identifier
integer$versionElement version
integer$redactionIdRedaction id
Renvoie
array The xml response
Depuis
3.2.0
Exceptions
DomainException

Références $base, $id, $parameters, $path, et $version.

◆ relationsForElement()

relationsForElement (   $element,
  $id 
)

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

Paramètres
string$element[node|way|relation]
integer$idElement identifier
Renvoie
array The XML response
Depuis
3.2.0
Exceptions
DomainException

Références $base, $id, et $path.

◆ updateElement()

updateElement (   $element,
  $xml,
  $id 
)

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

Paramètres
string$element[node|way|relation]
string$xmlFull reperentation of the element with a version number
integer$idElement identifier
Renvoie
array The xml response
Depuis
3.2.0
Exceptions
DomainException

Références $base, $id, $parameters, et $path.

◆ versionOfElement()

versionOfElement (   $element,
  $id,
  $version 
)

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

Paramètres
string$element[node|way|relation]
integer$idElement identifier
integer$versionElement version
Renvoie
array The XML response
Depuis
3.2.0
Exceptions
DomainException

Références $base, $id, $path, et $version.

◆ waysForNode()

waysForNode (   $id)

Method to get ways for a Node element

Paramètres
integer$idNode identifier
Renvoie
array The XML response
Depuis
3.2.0

Références $base, $id, et $path.


La documentation de cette classe a été générée à partir du fichier suivant :