Docs For Class JGoogleData

Description

Google API data class for the Joomla Platform.

abstract:
since: 12.3

Located in /libraries/joomla/google/data.php (line 19)

Direct descendents

Class	Description
JGoogleDataAdsense	Google Adsense data class for the Joomla Platform.
JGoogleDataCalendar	Google Calendar data class for the Joomla Platform.
JGoogleDataPicasa	Google Picasa data class for the Joomla Platform.
JGoogleDataPicasaAlbum	Google Picasa data class for the Joomla Platform.
JGoogleDataPicasaPhoto	Google Picasa data class for the Joomla Platform.
JGoogleDataPlus	Google+ data class for the Joomla Platform.
JGoogleDataPlusActivities	Google+ data class for the Joomla Platform.
JGoogleDataPlusComments	Google+ data class for the Joomla Platform.
JGoogleDataPlusPeople	Google+ data class for the Joomla Platform.

Variable Summary

JGoogleAuth $auth

JRegistry $options

Method Summary

static SimpleXMLElement safeXML (string $data)

JGoogleData __construct ([JRegistry $options = null], [JGoogleAuth $auth = null])

boolean authenticate ()

mixed getOption (string $key)

boolean isAuthenticated ()

mixed listGetData (array $url, [int $maxpages = 1], [string $token = null])

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

JGoogleData setOption (string $key, mixed $value)

Variables

JGoogleAuth $auth (line 31)

var: Authentication client for the Google data object.
since: 12.3
access: protected

JRegistry $options (line 25)

var: Options for the Google data object.
since: 12.3
access: protected

Methods

static safeXML (line 81)

Method to validate XML

return: XMLElement of parsed data
throws: UnexpectedValueException
since: 12.3
access: protected

static SimpleXMLElement safeXML (string $data)

string $data: XML data to be parsed

Constructor __construct (line 41)

Constructor.

since: 12.3
access: public

JGoogleData __construct ([JRegistry $options = null], [JGoogleAuth $auth = null])

JRegistry $options: Google options object.
JGoogleAuth $auth: Google data http client object.

Redefined in descendants as:

JGoogleDataAdsense::__construct() : Constructor.
JGoogleDataCalendar::__construct() : Constructor.
JGoogleDataPicasa::__construct() : Constructor.
JGoogleDataPicasaAlbum::__construct() : Constructor.
JGoogleDataPicasaPhoto::__construct() : Constructor.
JGoogleDataPlus::__construct() : Constructor.
JGoogleDataPlusActivities::__construct() : Constructor.
JGoogleDataPlusComments::__construct() : Constructor.
JGoogleDataPlusPeople::__construct() : Constructor.

authenticate (line 54)

Method to authenticate to Google

return: True on success.
since: 12.3
access: public

boolean authenticate ()

getOption (line 164)

Get an option from the JGoogleData instance.

return: The option value.
since: 12.3
access: public

mixed getOption (string $key)

string $key: The name of the option to get.

isAuthenticated (line 66)

Check authentication

return: True if authenticated.
since: 12.3
access: public

boolean isAuthenticated ()

listGetData (line 105)

Method to retrieve a list of data

return: Data from Google
since: 12.3
throws: UnexpectedValueException
access: protected

mixed listGetData (array $url, [int $maxpages = 1], [string $token = null])

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

query (line 150)

Method to retrieve data from Google

return: Data from Google.
since: 12.3
access: protected

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

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.

setOption (line 179)

Set an option for the JGoogleData instance.

return: This object for method chaining.
since: 12.3
access: public

JGoogleData setOption (string $key, mixed $value)

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