Référence de la classe JTwitterOAuth

Graphe d'héritage de JTwitterOAuth:

Graphe de collaboration de JTwitterOAuth:

Liste de tous les membres

Fonctions membres publiques
	__construct (JRegistry $options=null, JHttp $client=null, JInput $input=null, JApplicationWeb $application=null)
	verifyCredentials ()
	endSession ()
	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 20 du fichier oauth.php.

---

Documentation des constructeurs et destructeur

JTwitterOAuth::__construct	(	JRegistry	$options = null,
		JHttp	$client = null,
		JInput	$input = null,
		JApplicationWeb	$application = null
	)

Constructor.

Paramètres:

JRegistry	$options	JTwitterOauth options object.
JHttp	$client	The HTTP client object.
JInput	$input	The input object.
JApplicationWeb	$application	The application object.

Depuis:

12.3

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', 'https://api.twitter.com/oauth/access_token');
                $this->options->def('authenticateURL', 'https://api.twitter.com/oauth/authenticate');
                $this->options->def('authoriseURL', 'https://api.twitter.com/oauth/authorize');
                $this->options->def('requestTokenURL', 'https://api.twitter.com/oauth/request_token');

                // Call the JOAuth1Client constructor to setup the object.
                parent::__construct($this->options, $client, $input, $application);
        }

Voici le graphe d'appel pour cette fonction :

---

Documentation des fonctions membres

JTwitterOAuth::endSession

(

)

Ends the session of the authenticating user, returning a null cookie.

Renvoie:

array The decoded JSON response

Depuis:

12.3

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

        {
                $token = $this->getToken();

                // Set parameters.
                $parameters = array('oauth_token' => $token['key']);

                // Set the API base
                $path = 'https://api.twitter.com/1.1/account/end_session.json';

                // Send the request.
                $response = $this->oauthRequest($path, 'POST', $parameters);

                return json_decode($response->body);
        }

JTwitterOAuth::validateResponse	(		$url,
			$response
	)

Method to validate a response.

Paramètres:

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

Renvoie:

void

Depuis:

12.3

Exceptions:

DomainException

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

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

        {
                if (strpos($url, 'verify_credentials') === false && $response->code != 200)
                {
                        $error = json_decode($response->body);

                        if (property_exists($error, 'error'))
                        {
                                throw new DomainException($error->error);
                        }
                        else
                        {
                                $error = $error->errors;
                                throw new DomainException($error[0]->message, $error[0]->code);
                        }
                }
        }

JTwitterOAuth::verifyCredentials

(

)

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

Renvoie:

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

Depuis:

12.3

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

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

        {
                $token = $this->getToken();

                // Set the parameters.
                $parameters = array('oauth_token' => $token['key']);

                // Set the API base
                $path = 'https://api.twitter.com/1.1/account/verify_credentials.json';

                // Send the request.
                $response = $this->oauthRequest($path, 'GET', $parameters);

                // Verify response
                if ($response->code == 200)
                {
                        return true;
                }
                else
                {
                        return false;
                }
        }

---

Documentation des données membres

JTwitterOAuth::$options

protected

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

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

---

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

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