Référence de la classe JGoogleAuthOauth2

Graphe d'héritage de JGoogleAuthOauth2:

Graphe de collaboration de JGoogleAuthOauth2:

Liste de tous les membres

Fonctions membres publiques
	__construct (JRegistry $options=null, JOAuth2Client $client=null)
	authenticate ()
	isAuthenticated ()
	query ($url, $data=null, $headers=null, $method= 'get')
Fonctions membres publiques inherited from JGoogleAuth
	getOption ($key)
	setOption ($key, $value)

Fonctions membres protégées
	googlize ()

Attributs protégés
	$client
Attributs protégés inherited from JGoogleAuth
	$options

---

Description détaillée

Définition à la ligne 20 du fichier oauth2.php.

---

Documentation des constructeurs et destructeur

JGoogleAuthOauth2::__construct	(	JRegistry	$options = null,
		JOAuth2Client	$client = null
	)

Constructor.

Paramètres:

JRegistry	$options	JGoogleAuth options object.
JOAuth2Client	$client	OAuth client for Google authentication.

Depuis:

12.3

Définition à la ligne 36 du fichier oauth2.php.

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

---

Documentation des fonctions membres

JGoogleAuthOauth2::authenticate

(

)

Method to authenticate to Google

Renvoie:

boolean True on success.

Depuis:

12.3

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

Définition à la ligne 49 du fichier oauth2.php.

        {
                $this->googlize();

                return $this->client->authenticate();
        }

JGoogleAuthOauth2::googlize ( )

protected

Method to fill in Google-specific OAuth settings

Renvoie:

JOAuth2Client Google-configured Oauth2 client.

Depuis:

12.3

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

        {
                if (!$this->client->getOption('authurl'))
                {
                        $this->client->setOption('authurl', 'https://accounts.google.com/o/oauth2/auth');
                }
                if (!$this->client->getOption('tokenurl'))
                {
                        $this->client->setOption('tokenurl', 'https://accounts.google.com/o/oauth2/token');
                }
                if (!$this->client->getOption('requestparams'))
                {
                        $this->client->setOption('requestparams', Array());
                }

                $params = $this->client->getOption('requestparams');

                if (!array_key_exists('access_type', $params))
                {
                        $params['access_type'] = 'offline';
                }
                if ($params['access_type'] == 'offline' && $this->client->getOption('userefresh') === null)
                {
                        $this->client->setOption('userefresh', true);
                }
                if (!array_key_exists('approval_prompt', $params))
                {
                        $params['approval_prompt'] = 'auto';
                }

                $this->client->setOption('requestparams', $params);

                return $this->client;
        }

JGoogleAuthOauth2::isAuthenticated

(

)

Verify if the client has been authenticated

Renvoie:

boolean Is authenticated

Depuis:

12.3

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

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

        {
                return $this->client->isAuthenticated();
        }

JGoogleAuthOauth2::query	(		$url,
			$data = null,
			$headers = null,
			$method = 'get'
	)

Method to retrieve data from Google

Paramètres:

string	$url	The URL for the request.
mixed	$data	The data to include in the request.
array	$headers	The headers to send with the request.
string	$method	The type of http request to send.

Renvoie:

mixed Data from Google.

Depuis:

12.3

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

Définition à la ligne 80 du fichier oauth2.php.

        {
                $this->googlize();

                return $this->client->query($url, $data, $headers, $method);
        }

---

Documentation des données membres

JGoogleAuthOauth2::$client

protected

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

---

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

• jplatform-13.1/joomla/google/auth/oauth2.php