JGoogle
Joomla Platform class for interacting with the Google APIs.
| property-read |
Google API object for data. Google API object for embed generation. |
|---|---|
| since |
3.1.4 |
| deprecated |
4.0 Use the |
| 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
\JGoogleAuthThe authentication client object.
data
Method to create JGoogleData objects
data(string $name, \Joomla\Registry\Registry $options = null, \JGoogleAuth $auth = null) : \JGoogleData
| since |
3.1.4 |
|---|
Arguments
- $name
stringName of property to retrieve- $options
\Joomla\Registry\RegistryGoogle options object.- $auth
\JGoogleAuthThe authentication client object.
Response
\JGoogleDataGoogle data API object.
embed
Method to create JGoogleEmbed objects
embed(string $name, \Joomla\Registry\Registry $options = null) : \JGoogleEmbed
| since |
3.1.4 |
|---|
Arguments
- $name
stringName of property to retrieve- $options
\Joomla\Registry\RegistryGoogle options object.
Response
\JGoogleEmbedGoogle embed API object.
getOption
Get an option from the JGoogle instance.
getOption(string $key) : mixed
| since |
3.1.4 |
|---|
Arguments
- $key
stringThe name of the option to get.
Response
mixedThe option value.
setOption
Set an option for the JGoogle instance.
setOption(string $key, mixed $value) : \JGoogle
| since |
3.1.4 |
|---|
Arguments
- $key
stringThe name of the option to set.- $value
mixedThe option value to set.
Response
\JGoogleThis object for method chaining.
Properties
auth
The authentication client object to use in sending authenticated HTTP requests.
data
Google API object for data.
Type(s)
\JGoogleData
embed
Google API object for embed generation.
Type(s)
\JGoogleEmbed