Docs For Class JGoogle

Description

Joomla Platform class for interacting with the Google APIs.

property-read: JGoogleData $data: Google API object for data.
property-read: JGoogleEmbed $embed: Google API object for embed generation.
since: 12.3

Located in /libraries/joomla/google/google.php (line 22)

Variable Summary

JAuth $auth

JGoogleData $data

JGoogleEmbed $embed

JRegistry $options

Method Summary

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

JGoogleData data (string $name, [JRegistry $options = null], [JAuth $auth = null])

JGoogleEmbed embed (string $name, [JRegistry $options = null])

mixed getOption (string $key)

JGoogle setOption (string $key, mixed $value)

Variables

JAuth $auth (line 34)

var: The authentication client object to use in sending authenticated HTTP requests.
since: 12.3
access: protected

JGoogleData $data (line 40)

var: Google API object for data request.
since: 12.3
access: protected

JGoogleEmbed $embed (line 46)

var: Google API object for embed generation.
since: 12.3
access: protected

JRegistry $options (line 28)

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

Methods

Constructor __construct (line 56)

Constructor.

since: 12.3
access: public

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

JRegistry $options: Google options object.
JAuth $auth: The authentication client object.

data (line 73)

Method to create JGoogleData objects

return: Google data API object.
since: 12.3
access: public

JGoogleData data (string $name, [JRegistry $options = null], [JAuth $auth = null])

string $name: Name of property to retrieve
JRegistry $options: Google options object.
JAuth $auth: The authentication client object.

embed (line 112)

Method to create JGoogleEmbed objects

return: Google embed API object.
since: 12.3
access: public

JGoogleEmbed embed (string $name, [JRegistry $options = null])

string $name: Name of property to retrieve
JRegistry $options: Google options object.

getOption (line 140)

Get an option from the JGoogle instance.

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

mixed getOption (string $key)

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

setOption (line 155)

Set an option for the JGoogle instance.

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

JGoogle setOption (string $key, mixed $value)

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