JGoogleDataPlus
Extends \JGoogleDataGoogle+ data class for the Joomla Platform.
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
Google data http client object.
__get
Magic method to lazily create API objects
__get(string $name) : \JGoogleDataPlus
since |
3.1.4 |
---|
Arguments
- $name
string
Name of property to retrieve
Response
\JGoogleDataPlus
Google+ API object (people, activities, comments).
authenticate
Method to authenticate to Google
authenticate() : boolean
since |
3.1.4 |
---|
Response
boolean
True on success.
getOption
Get an option from the JGoogleData instance.
getOption(string $key) : mixed
since |
3.1.4 |
---|
Arguments
- $key
string
The name of the option to get.
Response
mixed
The option value.
isAuthenticated
Check authentication
isAuthenticated() : boolean
since |
3.1.4 |
---|
Response
boolean
True if authenticated.
listGetData
Method to retrieve a list of data
listGetData(array $url, integer $maxpages = 1, string $token = null) : mixed
since |
3.1.4 |
---|---|
throws |
|
Arguments
- $url
array
URL to GET- $maxpages
integer
Maximum number of pages to return- $token
string
Next page token
Response
mixed
Data from Google
query
Method to retrieve data from Google
query(string $url, mixed $data = null, array $headers = null, string $method = 'get') : mixed
since |
3.1.4 |
---|
Arguments
- $url
string
The URL for the request.- $data
mixed
The data to include in the request.- $headers
array
The headers to send with the request.- $method
string
The type of http request to send.
Response
mixed
Data from Google.
safeXml
Method to validate XML
safeXml(string $data) : \SimpleXMLElement
since |
3.1.4 |
---|---|
throws |
|
Arguments
- $data
string
XML data to be parsed
Response
\SimpleXMLElement
XMLElement of parsed data
setOption
Set an option for the JGoogleData instance.
setOption(string $key, mixed $value) : \JGoogleData
since |
3.1.4 |
---|
Arguments
- $key
string
The name of the option to set.- $value
mixed
The option value to set.
Response
\JGoogleData
This object for method chaining.