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 JOpenstreetmap

Liste de tous les membres

Fonctions membres publiques

 __construct (JOpenstreetmapOauth $oauth=null, JRegistry $options=null, JHttp $client=null)
 __get ($name)
 getOption ($key)
 setOption ($key, $value)

Attributs protégés

 $options
 $client
 $oauth
 $changesets
 $elements
 $gps
 $info
 $user

Description détaillée

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


Documentation des constructeurs et destructeur

JOpenstreetmap::__construct ( JOpenstreetmapOauth  $oauth = null,
JRegistry  $options = null,
JHttp  $client = null 
)

Constructor.

Paramètres:
JOpenstreetmapOauth$oauthOpenstreetmap oauth client
JRegistry$optionsOpenstreetmap options object
JHttp$clientThe HTTP client object
Depuis:
13.1

Définition à la ligne 94 du fichier openstreetmap.php.

{
$this->oauth = $oauth;
$this->options = isset($options) ? $options : new JRegistry;
$this->client = isset($client) ? $client : new JHttp($this->options);
// Setup the default API url if not already set.
$this->options->def('api.url', 'http://api.openstreetmap.org/api/0.6/');
// $this->options->def('api.url', 'http://api06.dev.openstreetmap.org/api/0.6/');
}

Documentation des fonctions membres

JOpenstreetmap::__get (   $name)

Method to get object instances

Paramètres:
string$nameName of property to retrieve
Renvoie:
JOpenstreetmapObject Openstreetmap API object
Depuis:
13.1
Exceptions:
InvalidArgumentException

Définition à la ligne 116 du fichier openstreetmap.php.

{
$class = 'JOpenstreetmap' . ucfirst($name);
if (class_exists($class))
{
if (false == isset($this->$name))
{
$this->$name = new $class($this->options, $this->client, $this->oauth);
}
return $this->$name;
}
throw new InvalidArgumentException(sprintf('Argument %s produced an invalid class name: %s', $name, $class));
}
JOpenstreetmap::getOption (   $key)

Get an option from the JOpenstreetmap instance.

Paramètres:
string$keyThe name of the option to get.
Renvoie:
mixed The option value.
Depuis:
13.1

Définition à la ligne 142 du fichier openstreetmap.php.

{
return $this->options->get($key);
}
JOpenstreetmap::setOption (   $key,
  $value 
)

Set an option for the Openstreetmap instance.

Paramètres:
string$keyThe name of the option to set.
mixed$valueThe option value to set.
Renvoie:
JOpenstreetmap This object for method chaining.
Depuis:
13.1

Définition à la ligne 157 du fichier openstreetmap.php.

{
$this->options->set($key, $value);
return $this;
}

Documentation des données membres

JOpenstreetmap::$changesets
protected

Définition à la ligne 51 du fichier openstreetmap.php.

JOpenstreetmap::$client
protected

Définition à la ligne 35 du fichier openstreetmap.php.

JOpenstreetmap::$elements
protected

Définition à la ligne 59 du fichier openstreetmap.php.

JOpenstreetmap::$gps
protected

Définition à la ligne 67 du fichier openstreetmap.php.

JOpenstreetmap::$info
protected

Définition à la ligne 75 du fichier openstreetmap.php.

JOpenstreetmap::$oauth
protected

Définition à la ligne 43 du fichier openstreetmap.php.

JOpenstreetmap::$options
protected

Définition à la ligne 27 du fichier openstreetmap.php.

JOpenstreetmap::$user
protected

Définition à la ligne 83 du fichier openstreetmap.php.


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