Référence de la classe JOpenstreetmapObject

Graphe d'héritage de JOpenstreetmapObject:

Liste de tous les membres

Fonctions membres publiques
	__construct (JRegistry &$options=null, JHttp $client=null, JOpenstreetmapOauth $oauth=null)
	getOption ($key)
	setOption ($key, $value)
	sendRequest ($path, $method= 'GET', $headers=array(), $data= '')

Attributs protégés
	$options
	$client
	$oauth

---

Description détaillée

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

---

Documentation des constructeurs et destructeur

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

Constructor

Paramètres:

JRegistry	&$options	Openstreetmap options object.
JHttp	$client	The HTTP client object.
JOpenstreetmapOauth	$oauth	Openstreetmap oauth client

Depuis:

13.1

Définition à la ligne 54 du fichier object.php.

        {
                $this->options = isset($options) ? $options : new JRegistry;
                $this->client = isset($client) ? $client : new JHttp($this->options);
                $this->oauth = $oauth;
        }

---

Documentation des fonctions membres

JOpenstreetmapObject::getOption

(

$key

)

Get an option from the JOpenstreetmapObject instance.

Paramètres:

string

$key

The name of the option to get.

Renvoie:

mixed The option value.

Depuis:

13.1

Définition à la ligne 70 du fichier object.php.

        {
                return $this->options->get($key);
        }

JOpenstreetmapObject::sendRequest	(		$path,
			$method = 'GET',
			$headers = array(),
			$data = ''
	)

Method to send the request which does not require authentication.

Paramètres:

string	$path	The path of the request to make
string	$method	The request method.
array	$headers	The headers passed in the request.
mixed	$data	Either an associative array or a string to be sent with the post request.

Renvoie:

SimpleXMLElement The XML response

Depuis:

13.1

Exceptions:

DomainException

Définition à la ligne 105 du fichier object.php.

        {
                // Send the request.
                switch ($method)
                {
                        case 'GET':
                                $response = $this->client->get($path, $headers);
                                break;

                        case 'POST':
                                $response = $this->client->post($path, $data, $headers);
                                break;
                }

                // Validate the response code.
                if ($response->code != 200)
                {
                        $error = htmlspecialchars($response->body);

                        throw new DomainException($error, $response->code);
                }

                $xml_string = simplexml_load_string($response->body);

                return $xml_string;
        }

JOpenstreetmapObject::setOption	(		$key,
			$value
	)

Set an option for the JOpenstreetmapObject instance.

Paramètres:

string	$key	The name of the option to set.
mixed	$value	The option value to set.

Renvoie:

JOpenstreetmapObject This object for method chaining.

Depuis:

13.1

Définition à la ligne 85 du fichier object.php.

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

                return $this;
        }

---

Documentation des données membres

JOpenstreetmapObject::$client

protected

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

JOpenstreetmapObject::$oauth

protected

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

JOpenstreetmapObject::$options

protected

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

---

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

• jplatform-13.1/joomla/openstreetmap/object.php