Référence de la classe JOpenstreetmapOauth

Graphe d'héritage de JOpenstreetmapOauth:

Graphe de collaboration de JOpenstreetmapOauth:

Liste de tous les membres

Fonctions membres publiques
	__construct (JRegistry $options=null, JHttp $client=null, JInput $input=null)
	verifyCredentials ()
	validateResponse ($url, $response)
Fonctions membres publiques inherited from JOAuth1Client
	__construct (JRegistry $options=null, JHttp $client=null, JInput $input=null, JApplicationWeb $application=null, $version=null)
	authenticate ()
	oauthRequest ($url, $method, $parameters, $data=array(), $headers=array())
	toUrl ($url, $parameters)
	safeEncode ($data)
	getOption ($key)
	setOption ($key, $value)
	getToken ()
	setToken ($token)

Attributs protégés
	$options
Attributs protégés inherited from JOAuth1Client
	$token = array()
	$client
	$input
	$application
	$version

Additional Inherited Members
Fonctions membres publiques statiques inherited from JOAuth1Client
static	generateNonce ()

---

Description détaillée

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

---

Documentation des constructeurs et destructeur

JOpenstreetmapOauth::__construct	(	JRegistry	$options = null,
		JHttp	$client = null,
		JInput	$input = null
	)

Constructor.

Paramètres:

JRegistry	$options	JOpenstreetmapOauth options object.
JHttp	$client	The HTTP client object.
JInput	$input	The input object

Depuis:

13.1

Définition à la ligne 38 du fichier oauth.php.

Références JRegistry\def().

        {
                $this->options = isset($options) ? $options : new JRegistry;

                $this->options->def('accessTokenURL', 'http://www.openstreetmap.org/oauth/access_token');
                $this->options->def('authoriseURL', 'http://www.openstreetmap.org/oauth/authorize');
                $this->options->def('requestTokenURL', 'http://www.openstreetmap.org/oauth/request_token');

                /*
                $this->options->def('accessTokenURL', 'http://api06.dev.openstreetmap.org/oauth/access_token');
                $this->options->def('authoriseURL', 'http://api06.dev.openstreetmap.org/oauth/authorize');
                $this->options->def('requestTokenURL', 'http://api06.dev.openstreetmap.org/oauth/request_token');
                */

                // Call the JOauth1Client constructor to setup the object.
                parent::__construct($this->options, $client, $input, null, '1.0');
        }

Voici le graphe d'appel pour cette fonction :

---

Documentation des fonctions membres

JOpenstreetmapOauth::validateResponse	(		$url,
			$response
	)

Method to validate a response.

Paramètres:

string	$url	The request URL.
JHttpResponse	$response	The response to validate.

Renvoie:

void

Depuis:

13.1

Exceptions:

DomainException

Réimplémentée à partir de JOAuth1Client.

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

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

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

JOpenstreetmapOauth::verifyCredentials

(

)

Method to verify if the access token is valid by making a request to an API endpoint.

Renvoie:

boolean Returns true if the access token is valid and false otherwise.

Depuis:

13.1

Réimplémentée à partir de JOAuth1Client.

Définition à la ligne 63 du fichier oauth.php.

        {
                return true;
        }

---

Documentation des données membres

JOpenstreetmapOauth::$options

protected

Réimplémentée à partir de JOAuth1Client.

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

---

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

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