Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe JGoogleData
+ Graphe d'héritage de JGoogleData:

Fonctions membres publiques

 __construct (Registry $options=null, JGoogleAuth $auth=null)
 
 authenticate ()
 
 isAuthenticated ()
 
 getOption ($key)
 
 setOption ($key, $value)
 

Fonctions membres protégées

 listGetData ($url, $maxpages=1, $token=null)
 
 query ($url, $data=null, $headers=null, $method='get')
 

Fonctions membres protégées statiques

static safeXml ($data)
 

Attributs protégés

 $options
 
 $auth
 

Description détaillée

Google API data class for the Joomla Platform.

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

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( Registry  $options = null,
JGoogleAuth  $auth = null 
)

Constructor.

Paramètres
Registry$optionsGoogle options object.
JGoogleAuth$authGoogle data http client object.
Depuis
12.3

Références $options.

Documentation des fonctions membres

◆ authenticate()

authenticate ( )

Method to authenticate to Google

Renvoie
boolean True on success.
Depuis
12.3

◆ getOption()

getOption (   $key)

Get an option from the JGoogleData instance.

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

Références $key.

◆ isAuthenticated()

isAuthenticated ( )

Check authentication

Renvoie
boolean True if authenticated.
Depuis
12.3

◆ listGetData()

listGetData (   $url,
  $maxpages = 1,
  $token = null 
)
protected

Method to retrieve a list of data

Paramètres
array$urlURL to GET
int$maxpagesMaximum number of pages to return
string$tokenNext page token
Renvoie
mixed Data from Google
Depuis
12.3
Exceptions
UnexpectedValueException

Références $data, $url, et elseif.

◆ query()

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

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
12.3

Références $data, et $url.

◆ safeXml()

static safeXml (   $data)
staticprotected

Method to validate XML

Paramètres
string$dataXML data to be parsed
Renvoie
SimpleXMLElement XMLElement of parsed data
Depuis
12.3
Exceptions
UnexpectedValueException

Références $data.

◆ setOption()

setOption (   $key,
  $value 
)

Set an option for the JGoogleData instance.

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

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

Documentation des champs

◆ $auth

$auth
protected

◆ $options

$options
protected

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