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\Registry
Google options object.- $auth
\JGoogleAuth
The 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
string
Name of property to retrieve- $options
\Joomla\Registry\Registry
Google options object.- $auth
\JGoogleAuth
The authentication client object.
Response
\JGoogleData
Google data API object.
embed
Method to create JGoogleEmbed objects
embed(string $name, \Joomla\Registry\Registry $options = null) : \JGoogleEmbed
since |
3.1.4 |
---|
Arguments
- $name
string
Name of property to retrieve- $options
\Joomla\Registry\Registry
Google options object.
Response
\JGoogleEmbed
Google embed API object.
getOption
Get an option from the JGoogle instance.
getOption(string $key) : mixed
since |
3.1.4 |
---|
Arguments
- $key
string
The name of the option to get.
Response
mixed
The option value.
setOption
Set an option for the JGoogle instance.
setOption(string $key, mixed $value) : \JGoogle
since |
3.1.4 |
---|
Arguments
- $key
string
The name of the option to set.- $value
mixed
The option value to set.
Response
\JGoogle
This 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