Référence de la classe JGoogleDataPlusComments

Graphe d'héritage de JGoogleDataPlusComments:

Graphe de collaboration de JGoogleDataPlusComments:

Liste de tous les membres

Fonctions membres publiques
	__construct (JRegistry $options=null, JGoogleAuth $auth=null)
	listComments ($activityId, $fields=null, $max=20, $order=null, $token=null, $alt=null)
	getComment ($id, $fields=null)
Fonctions membres publiques inherited from JGoogleData
	authenticate ()
	isAuthenticated ()
	getOption ($key)
	setOption ($key, $value)

Additional Inherited Members
Fonctions membres protégées inherited from JGoogleData
	listGetData ($url, $maxpages=1, $token=null)
	query ($url, $data=null, $headers=null, $method= 'get')
Fonctions membres protégées statiques inherited from JGoogleData
static	safeXML ($data)
Attributs protégés inherited from JGoogleData
	$options
	$auth

---

Description détaillée

Définition à la ligne 19 du fichier comments.php.

---

Documentation des constructeurs et destructeur

JGoogleDataPlusComments::__construct	(	JRegistry	$options = null,
		JGoogleAuth	$auth = null
	)

Constructor.

Paramètres:

JRegistry	$options	Google options object
JGoogleAuth	$auth	Google data http client object

Depuis:

1234

Réimplémentée à partir de JGoogleData.

Définition à la ligne 29 du fichier comments.php.

        {
                parent::__construct($options, $auth);

                if (isset($this->auth) && !$this->auth->getOption('scope'))
                {
                        $this->auth->setOption('scope', 'https://www.googleapis.com/auth/plus.me');
                }
        }

---

Documentation des fonctions membres

JGoogleDataPlusComments::getComment	(		$id,
			$fields = null
	)

Get a comment.

Paramètres:

string	$id	The ID of the comment to get.
string	$fields	Used to specify the fields you want returned.

Renvoie:

mixed Data from Google

Depuis:

1234

Définition à la ligne 114 du fichier comments.php.

        {
                if ($this->isAuthenticated())
                {
                        $url = $this->getOption('api.url') . 'comments/' . $id;

                        // Check if fields is specified.
                        if ($fields)
                        {
                                $url .= '?fields=' . $fields;
                        }

                        $jdata = $this->auth->query($url);

                        return json_decode($jdata->body, true);
                }
                else
                {
                        return false;
                }
        }

JGoogleDataPlusComments::listComments	(		$activityId,
			$fields = null,
			$max = 20,
			$order = null,
			$token = null,
			$alt = null
	)

List all of the comments for an activity.

Paramètres:

string	$activityId	The ID of the activity to get comments for.
string	$fields	Used to specify the fields you want returned.
integer	$max	The maximum number of people to include in the response, used for paging.
string	$order	The order in which to sort the list of comments. Acceptable values are "ascending" and "descending".
string	$token	The 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.
string	$alt	Specifies an alternative representation type. Acceptable values are: "json" - Use JSON format (default)

Renvoie:

mixed Data from Google

Depuis:

1234

Définition à la ligne 54 du fichier comments.php.

        {
                if ($this->isAuthenticated())
                {
                        $url = $this->getOption('api.url') . 'activities/' . $activityId . '/comments';

                        // Check if fields is specified.
                        if ($fields)
                        {
                                $url .= '?fields=' . $fields;
                        }

                        // Check if max is specified.
                        if ($max != 20)
                        {
                                $url .= (strpos($url, '?') === false) ? '?maxResults=' : '&maxResults=';
                                $url .= $max;
                        }

                        // Check if order is specified.
                        if ($order)
                        {
                                $url .= (strpos($url, '?') === false) ? '?orderBy=' : '&orderBy=';
                                $url .= $order;
                        }

                        // Check of token is specified.
                        if ($token)
                        {
                                $url .= (strpos($url, '?') === false) ? '?pageToken=' : '&pageToken=';
                                $url .= $token;
                        }

                        // Check if alt is specified.
                        if ($alt)
                        {
                                $url .= (strpos($url, '?') === false) ? '?alt=' : '&alt=';
                                $url .= $alt;
                        }

                        $jdata = $this->auth->query($url);

                        return json_decode($jdata->body, true);
                }
                else
                {
                        return false;
                }
        }

---

La documentation de cette classe a été générée à partir du fichier suivant :

• jplatform-13.1/joomla/google/data/plus/comments.php