Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JOpenstreetmapInfo
+ Graphe d'héritage de JOpenstreetmapInfo:
+ Graphe de collaboration de JOpenstreetmapInfo:

Liste de tous les membres

Fonctions membres publiques

 getCapabilities ()
 retrieveMapData ($left, $bottom, $right, $top)
 retrievePermissions ()
- Fonctions membres publiques inherited from JOpenstreetmapObject
 __construct (JRegistry &$options=null, JHttp $client=null, JOpenstreetmapOauth $oauth=null)
 getOption ($key)
 setOption ($key, $value)
 sendRequest ($path, $method= 'GET', $headers=array(), $data= '')

Additional Inherited Members

- Attributs protégés inherited from JOpenstreetmapObject
 $options
 $client
 $oauth

Description détaillée

Définition à la ligne 19 du fichier info.php.


Documentation des fonctions membres

JOpenstreetmapInfo::getCapabilities ( )

Method to get capabilities of the API

Renvoie:
array The XML response
Depuis:
13.1

Définition à la ligne 28 du fichier info.php.

{
// Set the API base
$base = 'capabilities';
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET', array());
$xml_string = simplexml_load_string($response->body);
return $xml_string;
}
JOpenstreetmapInfo::retrieveMapData (   $left,
  $bottom,
  $right,
  $top 
)

Method to retrieve map data of a bounding box

Paramètres:
float$leftLeft boundary
float$bottomBottom boundary
float$rightRight boundary
float$topTop boundary
Renvoie:
array The XML response
Depuis:
13.1

Définition à la ligne 56 du fichier info.php.

{
// Set the API base
$base = 'map?bbox=' . $left . ',' . $bottom . ',' . $right . ',' . $top;
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET', array());
$xml_string = simplexml_load_string($response->body);
return $xml_string;
}
JOpenstreetmapInfo::retrievePermissions ( )

Method to retrieve permissions for current user

Renvoie:
array The XML response
Depuis:
13.1

Définition à la ligne 79 du fichier info.php.

{
// Set the API base
$base = 'permissions';
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET', array());
$xml_string = simplexml_load_string($response->body);
return $xml_string;
}

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