Référence de la classe JGoogleData

Graphe d'héritage de JGoogleData:

Liste de tous les membres

Fonctions membres publiques
	__construct (JRegistry $options=null, JGoogleAuth $auth=null)
	authenticate ()
	isAuthenticated ()
	getOption ($key)
	setOption ($key, $value)

Fonctions membres protégées
	listGetData ($url, $maxpages=1, $token=null)
	query ($url, $data=null, $headers=null, $method= 'get')

Fonctions membres protégées statiques
static	safeXML ($data)

Attributs protégés
	$options
	$auth

---

Description détaillée

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

---

Documentation des constructeurs et destructeur

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

Constructor.

Paramètres:

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

Depuis:

12.3

Réimplémentée dans JGoogleDataPlus, JGoogleDataAdsense, JGoogleDataCalendar, JGoogleDataPicasa, JGoogleDataPlusActivities, JGoogleDataPlusComments, et JGoogleDataPlusPeople.

Définition à la ligne 41 du fichier data.php.

        {
                $this->options = isset($options) ? $options : new JRegistry;
                $this->auth = isset($auth) ? $auth : new JGoogleAuthOauth2($this->options);
        }

---

Documentation des fonctions membres

JGoogleData::authenticate

(

)

Method to authenticate to Google

Renvoie:

boolean True on success.

Depuis:

12.3

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

        {
                return $this->auth->authenticate();
        }

JGoogleData::getOption

(

$key

)

Get an option from the JGoogleData instance.

Paramètres:

string

$key

The name of the option to get.

Renvoie:

mixed The option value.

Depuis:

12.3

Définition à la ligne 164 du fichier data.php.

        {
                return $this->options->get($key);
        }

JGoogleData::isAuthenticated

(

)

Check authentication

Renvoie:

boolean True if authenticated.

Depuis:

12.3

Définition à la ligne 66 du fichier data.php.

        {
                return $this->auth->isAuthenticated();
        }

JGoogleData::listGetData (   $url,   $maxpages = 1,   $token = null  )

protected

Method to retrieve a list of data

Paramètres:

array	$url	URL to GET
int	$maxpages	Maximum number of pages to return
string	$token	Next page token

Renvoie:

mixed Data from Google

Depuis:

12.3

Exceptions:

UnexpectedValueException

Définition à la ligne 105 du fichier data.php.

        {
                $qurl = $url;

                if (strpos($url, '&') && isset($token))
                {
                        $qurl .= '&pageToken=' . $token;
                }
                elseif (isset($token))
                {
                        $qurl .= 'pageToken=' . $token;
                }
                $jdata = $this->query($qurl);
                $data = json_decode($jdata->body, true);

                if ($data && array_key_exists('items', $data))
                {
                        if ($maxpages != 1 && array_key_exists('nextPageToken', $data))
                        {
                                $data['items'] = array_merge($data['items'], $this->listGetData($url, $maxpages - 1, $data['nextPageToken']));
                        }
                        return $data['items'];
                }
                elseif ($data)
                {
                        return array();
                }
                else
                {
                        throw new UnexpectedValueException("Unexpected data received from Google: `{$jdata->body}`.");
                }
        }

JGoogleData::query (   $url,   $data = null,   $headers = null,   $method = 'get'  )

protected

Method to retrieve data from Google

Paramètres:

string	$url	The URL for the request.
mixed	$data	The data to include in the request.
array	$headers	The headers to send with the request.
string	$method	The type of http request to send.

Renvoie:

mixed Data from Google.

Depuis:

12.3

Définition à la ligne 150 du fichier data.php.

        {
                return $this->auth->query($url, $data, $headers, $method);
        }

static JGoogleData::safeXML (   $data )

staticprotected

Method to validate XML

Paramètres:

string

$data

XML data to be parsed

Renvoie:

SimpleXMLElement XMLElement of parsed data

Depuis:

12.3

Exceptions:

UnexpectedValueException

Définition à la ligne 81 du fichier data.php.

        {
                try
                {
                        return new SimpleXMLElement($data, LIBXML_NOWARNING | LIBXML_NOERROR);
                }
                catch (Exception $e)
                {
                        throw new UnexpectedValueException("Unexpected data received from Google: `$data`.");
                }
        }

JGoogleData::setOption	(		$key,
			$value
	)

Set an option for the JGoogleData instance.

Paramètres:

string	$key	The name of the option to set.
mixed	$value	The option value to set.

Renvoie:

JGoogleData This object for method chaining.

Depuis:

12.3

Définition à la ligne 179 du fichier data.php.

        {
                $this->options->set($key, $value);

                return $this;
        }

---

Documentation des données membres

JGoogleData::$auth

protected

Définition à la ligne 31 du fichier data.php.

JGoogleData::$options

protected

Définition à la ligne 25 du fichier data.php.

---

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

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