JGoogleData

Google API data class for the Joomla Platform.

abstract deprecated
since

3.1.4

deprecated

4.0 Use the joomla/google package via Composer instead

package

Joomla.Platform

Methods

__construct

Constructor.

__construct(\Joomla\Registry\Registry $options = null, \JGoogleAuth $auth = null) 
since

3.1.4

Arguments

$options

\Joomla\Registry\RegistryGoogle options object.

$auth

\JGoogleAuthGoogle data http client object.

authenticate

Method to authenticate to Google

authenticate() : boolean
since

3.1.4

Response

booleanTrue on success.

getOption

Get an option from the JGoogleData instance.

getOption(string $key) : mixed
since

3.1.4

Arguments

$key

stringThe name of the option to get.

Response

mixedThe option value.

isAuthenticated

Check authentication

isAuthenticated() : boolean
since

3.1.4

Response

booleanTrue if authenticated.

listGetData

Method to retrieve a list of data

listGetData(array $url, integer $maxpages = 1, string $token = null) : mixed
since

3.1.4

throws

\UnexpectedValueException

Arguments

$url

arrayURL to GET

$maxpages

integerMaximum number of pages to return

$token

stringNext page token

Response

mixedData from Google

query

Method to retrieve data from Google

query(string $url, mixed $data = null, array $headers = null, string $method = 'get') : mixed
since

3.1.4

Arguments

$url

stringThe URL for the request.

$data

mixedThe data to include in the request.

$headers

arrayThe headers to send with the request.

$method

stringThe type of http request to send.

Response

mixedData from Google.

safeXml

Method to validate XML

safeXml(string $data) : \SimpleXMLElement
static
since

3.1.4

throws

\UnexpectedValueException

Arguments

$data

stringXML data to be parsed

Response

\SimpleXMLElementXMLElement of parsed data

setOption

Set an option for the JGoogleData instance.

setOption(string $key, mixed $value) : \JGoogleData
since

3.1.4

Arguments

$key

stringThe name of the option to set.

$value

mixedThe option value to set.

Response

\JGoogleDataThis object for method chaining.

Properties

options

Options for the Google data object.

since

3.1.4

Type(s)

\Joomla\Registry\Registry

auth

Authentication client for the Google data object.

since

3.1.4

Type(s)

\JGoogleAuth