Graphe d'héritage de JGoogleDataPicasaPhoto:

Graphe de collaboration de JGoogleDataPicasaPhoto:

Fonctions membres publiques
	__construct (SimpleXMLElement $xml, JRegistry $options=null, JGoogleAuth $auth=null)
	delete ($match= '*')
	getLink ($type= 'edit')
	getURL ()
	getThumbnails ()
	getTitle ()
	getSummary ()
	getAccess ()
	getTime ()
	getSize ()
	getHeight ()
	getWidth ()
	setTitle ($title)
	setSummary ($summary)
	setAccess ($access)
	setTime ($time)
	save ($match= '*')
	refresh ()
Fonctions membres publiques inherited from JGoogleData
	__construct (JRegistry $options=null, JGoogleAuth $auth=null)
	authenticate ()
	isAuthenticated ()
	getOption ($key)
	setOption ($key, $value)

Attributs protégés
	$xml
Attributs protégés inherited from JGoogleData
	$options
	$auth

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)

Description détaillée

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

Documentation des constructeurs et destructeur

JGoogleDataPicasaPhoto::__construct	(	SimpleXMLElement	$xml,
		JRegistry	$options = `null`,
		JGoogleAuth	$auth = `null`
	)

Constructor.

Paramètres:

SimpleXMLElement	$xml	XML from Google
JRegistry	$options	Google options object
JGoogleAuth	$auth	Google data http client object

Depuis:: 12.3

Définition à la ligne 36 du fichier photo.php.

        {
                $this->xml = $xml;
                parent::__construct($options, $auth);
                if (isset($this->auth) && !$this->auth->getOption('scope'))
                {
                        $this->auth->setOption('scope', 'https://picasaweb.google.com/data/');
                }
        }

Documentation des fonctions membres

JGoogleDataPicasaPhoto::delete ( $match = '*' )

Method to delete a Picasa photo

Paramètres:

mixed $match Check for most up to date photo

Renvoie:: boolean Success or failure.

Depuis:: 12.3

Exceptions:

UnexpectedValueException

Définition à la ligne 58 du fichier photo.php.

        {
                if ($this->isAuthenticated())
                {
                        $url = $this->getLink();
                        if ($match === true)
                        {
                                $match = $this->xml->xpath('./@gd:etag');
                                $match = $match[0];
                        }
                        try
                        {
                                $jdata = $this->query($url, null, array('GData-Version' => 2, 'If-Match' => $match), 'delete');
                        }
                        catch (Exception $e)
                        {
                                if (strpos($e->getMessage(), 'Error code 412 received requesting data: Mismatch: etags') === 0)
                                {
                                        throw new RuntimeException("Etag match failed: `$match`.");
                                }
                                throw $e;
                        }
                        if ($jdata->body != '')
                        {
                                throw new UnexpectedValueException("Unexpected data received from Google: `{$jdata->body}`.");
                        }
                        $this->xml = null;
                        return true;
                }
                else
                {
                        return false;
                }
        }

JGoogleDataPicasaPhoto::getAccess ( )

Method to get the access level of the photo

Renvoie:: string Photo access level

Depuis:: 12.3

Définition à la ligne 184 du fichier photo.php.

        {
                return (string) $this->xml->children('gphoto', true)->access;
        }

JGoogleDataPicasaPhoto::getHeight ( )

Method to get the height of the photo

Renvoie:: int Photo height

Depuis:: 12.3

Définition à la ligne 220 du fichier photo.php.

        {
                return (int) $this->xml->children('gphoto', true)->height;
        }

JGoogleDataPicasaPhoto::getLink ( $type = 'edit' )

Method to get the photo link

Paramètres:

string $type Type of link to return

Renvoie:: string Link or false on failure

Depuis:: 12.3

Définition à la ligne 106 du fichier photo.php.

        {
                $links = $this->xml->link;
                foreach ($links as $link)
                {
                        if ($link->attributes()->rel == $type)
                        {
                                return (string) $link->attributes()->href;
                        }
                }
                return false;
        }

JGoogleDataPicasaPhoto::getSize ( )

Method to get the size of the photo

Renvoie:: int Photo size

Depuis:: 12.3

Définition à la ligne 208 du fichier photo.php.

        {
                return (int) $this->xml->children('gphoto', true)->size;
        }

JGoogleDataPicasaPhoto::getSummary ( )

Method to get the summary of the photo

Renvoie:: string Photo description

Depuis:: 12.3

Définition à la ligne 172 du fichier photo.php.

        {
                return (string) $this->xml->children()->summary;
        }

JGoogleDataPicasaPhoto::getThumbnails ( )

Method to get the photo's thumbnails

Renvoie:: array An array of thumbnails

Depuis:: 12.3

Définition à la ligne 139 du fichier photo.php.

        {
                $thumbs = array();
                foreach ($this->xml->children('media', true)->group->thumbnail as $item)
                {
                        $url = (string) $item->attributes()->url;
                        $width = (int) $item->attributes()->width;
                        $height = (int) $item->attributes()->height;
                        $thumbs[$width] = array('url' => $url, 'w' => $width, 'h' => $height);
                }
                return $thumbs;
        }

JGoogleDataPicasaPhoto::getTime ( )

Method to get the time of the photo

Renvoie:: double Photo time

Depuis:: 12.3

Définition à la ligne 196 du fichier photo.php.

        {
                return (double) $this->xml->children('gphoto', true)->timestamp / 1000;
        }

JGoogleDataPicasaPhoto::getTitle ( )

Method to get the title of the photo

Renvoie:: string Photo title

Depuis:: 12.3

Définition à la ligne 160 du fichier photo.php.

        {
                return (string) $this->xml->children()->title;
        }

JGoogleDataPicasaPhoto::getURL ( )

Method to get the photo's URL

Renvoie:: string Link

Depuis:: 12.3

Définition à la ligne 127 du fichier photo.php.

        {
                return (string) $this->xml->children()->content->attributes()->src;
        }

JGoogleDataPicasaPhoto::getWidth ( )

Method to get the width of the photo

Renvoie:: int Photo width

Depuis:: 12.3

Définition à la ligne 232 du fichier photo.php.

        {
                return (int) $this->xml->children('gphoto', true)->width;
        }

JGoogleDataPicasaPhoto::refresh ( )

Refresh photo data

Renvoie:: mixed Data from Google

Depuis:: 12.3

Définition à la ligne 353 du fichier photo.php.

        {
                if ($this->isAuthenticated())
                {
                        $url = $this->getLink();
                        $jdata = $this->query($url, null, array('GData-Version' => 2));
                        $this->xml = $this->safeXML($jdata->body);
                        return $this;
                }
                else
                {
                        return false;
                }
        }

JGoogleDataPicasaPhoto::save ( $match = '*' )

Method to modify a Picasa Photo

Paramètres:

string $match Optional eTag matching parameter

Renvoie:: mixed Data from Google.

Depuis:: 12.3

Définition à la ligne 310 du fichier photo.php.

        {
                if ($this->isAuthenticated())
                {
                        $url = $this->getLink();
                        if ($match === true)
                        {
                                $match = $this->xml->xpath('./@gd:etag');
                                $match = $match[0];
                        }
                        try
                        {
                                $headers = array('GData-Version' => 2, 'Content-type' => 'application/atom+xml', 'If-Match' => $match);
                                $jdata = $this->query($url, $this->xml->asXML(), $headers, 'put');
                        }
                        catch (Exception $e)
                        {
                                if (strpos($e->getMessage(), 'Error code 412 received requesting data: Mismatch: etags') === 0)
                                {
                                        throw new RuntimeException("Etag match failed: `$match`.");
                                }
                                throw $e;
                        }
                        $this->xml = $this->safeXML($jdata->body);
                        return $this;
                }
                else
                {
                        return false;
                }
        }

JGoogleDataPicasaPhoto::setAccess ( $access )

Method to set the access level of the photo

Paramètres:

string $access New photo access level

Renvoie:: JGoogleDataPicasaPhoto The object for method chaining

Depuis:: 12.3

Définition à la ligne 278 du fichier photo.php.

        {
                $this->xml->children('gphoto', true)->access = $access;
                return $this;
        }

JGoogleDataPicasaPhoto::setSummary ( $summary )

Method to set the summary of the photo

Paramètres:

string $summary New photo description

Renvoie:: JGoogleDataPicasaPhoto The object for method chaining

Depuis:: 12.3

Définition à la ligne 262 du fichier photo.php.

        {
                $this->xml->children()->summary = $summary;
                return $this;
        }

JGoogleDataPicasaPhoto::setTime ( $time )

Method to set the time of the photo

Paramètres:

int $time New photo time

Renvoie:: JGoogleDataPicasaPhoto The object for method chaining

Depuis:: 12.3

Définition à la ligne 294 du fichier photo.php.

        {
                $this->xml->children('gphoto', true)->timestamp = $time * 1000;
                return $this;
        }

JGoogleDataPicasaPhoto::setTitle ( $title )

Method to set the title of the photo

Paramètres:

string $title New photo title

Renvoie:: JGoogleDataPicasaPhoto The object for method chaining

Depuis:: 12.3

Définition à la ligne 246 du fichier photo.php.

        {
                $this->xml->children()->title = $title;
                return $this;
        }

Documentation des données membres

JGoogleDataPicasaPhoto::$xml

protected

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

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

jplatform-13.1/joomla/google/data/picasa/photo.php

Fonctions membres publiques

Attributs protégés

Additional Inherited Members

Description détaillée

Documentation des constructeurs et destructeur

Documentation des fonctions membres

Documentation des données membres