Référence de la classe JLinkedinOauth

Graphe d'héritage de JLinkedinOauth:

Graphe de collaboration de JLinkedinOauth:

Liste de tous les membres

Fonctions membres publiques
	__construct (JRegistry $options=null, JHttp $client=null, JInput $input=null)
	verifyCredentials ()
	validateResponse ($url, $response)
	setScope ($scope)
	getScope ()
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

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

Constructor.

Paramètres:

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

Depuis:

13.1

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

Références JRegistry\def().

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

                $this->options->def('accessTokenURL', 'https://www.linkedin.com/uas/oauth/accessToken');
                $this->options->def('authenticateURL', 'https://www.linkedin.com/uas/oauth/authenticate');
                $this->options->def('authoriseURL', 'https://www.linkedin.com/uas/oauth/authorize');
                $this->options->def('requestTokenURL', 'https://www.linkedin.com/uas/oauth/requestToken');

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

Voici le graphe d'appel pour cette fonction :

---

Documentation des fonctions membres

JLinkedinOauth::getScope

(

)

Method to get the current scope

Renvoie:

string String or an array of string containing permissions.

Depuis:

13.1

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

        {
                return $this->getOption('scope');
        }

JLinkedinOauth::setScope

(

$scope

)

Method used to set permissions.

Paramètres:

mixed

$scope

String or an array of string containing permissions.

Renvoie:

JLinkedinOauth This object for method chaining

Voir également:

https://developer.linkedin.com/documents/authentication

Depuis:

13.1

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

        {
                $this->setOption('scope', $scope);

                return $this;
        }

JLinkedinOauth::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 96 du fichier oauth.php.

        {
                if (!$code = $this->getOption('success_code'))
                {
                        $code = 200;
                }

                if (strpos($url, '::(~)') === false && $response->code != $code)
                {
                        if ($error = json_decode($response->body))
                        {
                                throw new DomainException('Error code ' . $error->errorCode . ' received with message: ' . $error->message . '.');
                        }
                        else
                        {
                                throw new DomainException($response->body);
                        }
                }
        }

JLinkedinOauth::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 57 du fichier oauth.php.

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

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

                $data['format'] = 'json';

                // Set the API url.
                $path = 'https://api.linkedin.com/v1/people::(~)';

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

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

---

Documentation des données membres

JLinkedinOauth::$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/linkedin/oauth.php