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

3.1.4

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	$options	Google options object.
JGoogleAuth	$auth	Google data http client object.

Depuis

3.1.4

Références $options.

Documentation des fonctions membres

authenticate()

authenticate

(

)

Method to authenticate to Google

Renvoie

boolean True on success.

Depuis

3.1.4

getOption()

getOption

(

$key

)

Get an option from the JGoogleData instance.

Paramètres

string

$key

The name of the option to get.

Renvoie

mixed The option value.

Depuis

3.1.4

Références $key.

isAuthenticated()

isAuthenticated

(

)

Check authentication

Renvoie

boolean True if authenticated.

Depuis

3.1.4

listGetData()

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

protected

Method to retrieve a list of data

Paramètres

array	$url	URL to GET
int	$maxpages	Maximum number of pages to return
string	$token	Next page token

Renvoie

mixed Data from Google

Depuis

3.1.4

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	$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

3.1.4

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

safeXml()

static safeXml (   $data )

staticprotected

Method to validate XML

Paramètres

string

$data

XML data to be parsed

Renvoie

SimpleXMLElement XMLElement of parsed data

Depuis

3.1.4

Exceptions

UnexpectedValueException

Références $data.

setOption()

setOption	(		$key,
			$value
	)

Set an option for the JGoogleData instance.

Paramètres

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

Renvoie

JGoogleData This object for method chaining.

Depuis

3.1.4

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 :

• libraries/joomla/google/data.php