Référence de la classe JGoogleAuth

Graphe d'héritage de JGoogleAuth:

Liste de tous les membres

Fonctions membres publiques
	authenticate ()
	isAuthenticated ()
	query ($url, $data=null, $headers=null, $method= 'get')
	getOption ($key)
	setOption ($key, $value)

Attributs protégés
	$options

---

Description détaillée

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

---

Documentation des fonctions membres

JGoogleAuth::authenticate ( )

abstract

Abstract method to authenticate to Google

Renvoie:

boolean True on success.

Depuis:

12.3

Réimplémentée dans JGoogleAuthOauth2.

JGoogleAuth::getOption

(

$key

)

Get an option from the JGoogleAuth object.

Paramètres:

string

$key

The name of the option to get.

Renvoie:

mixed The option value.

Depuis:

12.3

Définition à la ligne 68 du fichier auth.php.

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

JGoogleAuth::isAuthenticated ( )

abstract

Verify if the client has been authenticated

Renvoie:

boolean Is authenticated

Depuis:

12.3

Réimplémentée dans JGoogleAuthOauth2.

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

abstract

Abstract 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 dans JGoogleAuthOauth2.

JGoogleAuth::setOption	(		$key,
			$value
	)

Set an option for the JGoogleAuth object.

Paramètres:

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

Renvoie:

JGoogleAuth This object for method chaining.

Depuis:

12.3

Définition à la ligne 83 du fichier auth.php.

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

                return $this;
        }

---

Documentation des données membres

JGoogleAuth::$options

protected

Définition à la ligne 25 du fichier auth.php.

---

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

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