Joomla! API

Extends \JGoogleData

Google+ data class for the Joomla Platform.

deprecated

since	3.1.4
deprecated	4.0 Use the `joomla/google` package via Composer instead
package	Joomla.Platform

Methods

Constructor.

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

inherited

since	3.1.4

Arguments

$options: \Joomla\Registry\RegistryGoogle options object.
$auth: \JGoogleAuthGoogle data http client object.

Magic method to lazily create API objects

__get(string $name) : \JGoogleDataPlus

since	3.1.4

Arguments

$name: stringName of property to retrieve

Response

\JGoogleDataPlusGoogle+ API object (people, activities, comments).

Method to authenticate to Google

authenticate() : boolean

inherited

since	3.1.4

Response

booleanTrue on success.

Get an option from the JGoogleData instance.

getOption(string $key) : mixed

inherited

since	3.1.4

Arguments

$key: stringThe name of the option to get.

Response

mixedThe option value.

Check authentication

isAuthenticated() : boolean

inherited

since	3.1.4

Response

booleanTrue if authenticated.

Method to retrieve a list of data

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

inherited

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

Method to retrieve data from Google

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

inherited

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.

Method to validate XML

safeXml(string $data) : \SimpleXMLElement

inherited static

since	3.1.4
throws	`\UnexpectedValueException`

Arguments

$data: stringXML data to be parsed

Response

\SimpleXMLElementXMLElement of parsed data

Set an option for the JGoogleData instance.

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

inherited

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

Google+ API object for people.

since	3.1.4

Type(s)

\JGoogleDataPlusPeople

Google+ API object for people.

since	3.1.4

Type(s)

\JGoogleDataPlusActivities

Google+ API object for people.

since	3.1.4

Type(s)

\JGoogleDataPlusComments

Options for the Google data object.

inherited

since	3.1.4

Type(s)

\Joomla\Registry\Registry

Authentication client for the Google data object.

inherited

since	3.1.4

Type(s)

\JGoogleAuth