Joomla! API

Download
Launch

JGoogleDataPlusComments

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

__construct

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.

authenticate

Method to authenticate to Google

authenticate() : boolean
inherited
since

3.1.4

Response

booleanTrue on success.

getComment

Get a comment.

getComment(string $id, string $fields = null) : mixed
since

3.1.4

Arguments

$id

stringThe ID of the comment to get.

$fields

stringUsed to specify the fields you want returned.

Response

mixedData from Google

getOption

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.

isAuthenticated

Check authentication

isAuthenticated() : boolean
inherited
since

3.1.4

Response

booleanTrue if authenticated.

listComments

List all of the comments for an activity.

listComments(string $activityId, string $fields = null, integer $max = 20, string $order = null, string $token = null, string $alt = null) : mixed
since

3.1.4

Arguments

$activityId

stringThe ID of the activity to get comments for.

$fields

stringUsed to specify the fields you want returned.

$max

integerThe maximum number of people to include in the response, used for paging.

$order

stringThe order in which to sort the list of comments. Acceptable values are "ascending" and "descending".

$token

stringThe continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token may be of any length.

$alt

stringSpecifies an alternative representation type. Acceptable values are: "json" - Use JSON format (default)

Response

mixedData from Google

listGetData

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

query

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.

safeXml

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

setOption

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

options

Options for the Google data object.

inherited
since

3.1.4

Type(s)

\Joomla\Registry\Registry

auth

Authentication client for the Google data object.

inherited
since

3.1.4

Type(s)

\JGoogleAuth
  • \ \
  • \ JGoogleDataPlusComments