Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JGoogleAuth
+ Graphe d'héritage de JGoogleAuth:

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

Google authentication class abstract

Depuis
3.1.4
Obsolète:
4.0 Use the joomla/google package via Composer instead

Documentation des fonctions membres

◆ authenticate()

authenticate ( )
abstract

Abstract method to authenticate to Google

Renvoie
boolean True on success.
Depuis
3.1.4

◆ getOption()

getOption (   $key)

Get an option from the JGoogleAuth object.

Paramètres
string$keyThe name of the option to get.
Renvoie
mixed The option value.
Depuis
3.1.4

Références $key.

◆ isAuthenticated()

isAuthenticated ( )
abstract

Verify if the client has been authenticated

Renvoie
boolean Is authenticated
Depuis
3.1.4

◆ query()

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

Abstract method to retrieve data from Google

Paramètres
string$urlThe URL for the request.
mixed$dataThe data to include in the request.
array$headersThe headers to send with the request.
string$methodThe type of http request to send.
Renvoie
mixed Data from Google.
Depuis
3.1.4

◆ setOption()

setOption (   $key,
  $value 
)

Set an option for the JGoogleAuth object.

Paramètres
string$keyThe name of the option to set.
mixed$valueThe option value to set.
Renvoie
JGoogleAuth This object for method chaining.
Depuis
3.1.4

Références $key, et $value.

Documentation des champs

◆ $options

$options
protected

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