Docs For Class JGoogleDataPicasaPhoto

Description

Google Picasa data class for the Joomla Platform.

since: 12.3

Located in /libraries/joomla/google/data/picasa/photo.php (line 19)

JGoogleData
   |
   --JGoogleDataPicasaPhoto

Variable Summary

SimpleXMLElement $xml

Method Summary

JGoogleDataPicasaPhoto __construct (SimpleXMLElement $xml, [JRegistry $options = null], [JGoogleAuth $auth = null])

boolean delete ([mixed $match = '*'])

string getAccess ()

int getHeight ()

string getLink ([string $type = 'edit'])

int getSize ()

string getSummary ()

array getThumbnails ()

double getTime ()

string getTitle ()

string getURL ()

int getWidth ()

mixed refresh ()

mixed save ([string $match = '*'])

JGoogleDataPicasaPhoto setAccess (string $access)

JGoogleDataPicasaPhoto setSummary (string $summary)

JGoogleDataPicasaPhoto setTime (int $time)

JGoogleDataPicasaPhoto setTitle (string $title)

Variables

SimpleXMLElement $xml (line 25)

var: The photo's XML
since: 12.3
access: protected

Inherited Variables

Inherited from JGoogleData

JGoogleData::$auth
JGoogleData::$options

Methods

Constructor __construct (line 36)

Constructor.

since: 12.3
access: public

JGoogleDataPicasaPhoto __construct (SimpleXMLElement $xml, [JRegistry $options = null], [JGoogleAuth $auth = null])

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

Redefinition of:

JGoogleData::__construct(): Constructor.

delete (line 58)

Method to delete a Picasa photo

return: Success or failure.
since: 12.3
throws: UnexpectedValueException
access: public

boolean delete ([mixed $match = '*'])

mixed $match: Check for most up to date photo

getAccess (line 184)

Method to get the access level of the photo

return: Photo access level
since: 12.3
access: public

string getAccess ()

getHeight (line 220)

Method to get the height of the photo

return: Photo height
since: 12.3
access: public

int getHeight ()

getLink (line 106)

Method to get the photo link

return: Link or false on failure
since: 12.3
access: public

string getLink ([string $type = 'edit'])

string $type: Type of link to return

getSize (line 208)

Method to get the size of the photo

return: Photo size
since: 12.3
access: public

int getSize ()

getSummary (line 172)

Method to get the summary of the photo

return: Photo description
since: 12.3
access: public

string getSummary ()

getThumbnails (line 139)

Method to get the photo's thumbnails

return: An array of thumbnails
since: 12.3
access: public

array getThumbnails ()

getTime (line 196)

Method to get the time of the photo

return: Photo time
since: 12.3
access: public

double getTime ()

getTitle (line 160)

Method to get the title of the photo

return: Photo title
since: 12.3
access: public

string getTitle ()

getURL (line 127)

Method to get the photo's URL

return: Link
since: 12.3
access: public

string getURL ()

getWidth (line 232)

Method to get the width of the photo

return: Photo width
since: 12.3
access: public

int getWidth ()

refresh (line 353)

Refresh photo data

return: Data from Google
since: 12.3
access: public

mixed refresh ()

save (line 310)

Method to modify a Picasa Photo

return: Data from Google.
since: 12.3
access: public

mixed save ([string $match = '*'])

string $match: Optional eTag matching parameter

setAccess (line 278)

Method to set the access level of the photo

return: The object for method chaining
since: 12.3
access: public

JGoogleDataPicasaPhoto setAccess (string $access)

string $access: New photo access level

setSummary (line 262)

Method to set the summary of the photo

return: The object for method chaining
since: 12.3
access: public

JGoogleDataPicasaPhoto setSummary (string $summary)

string $summary: New photo description

setTime (line 294)

Method to set the time of the photo

return: The object for method chaining
since: 12.3
access: public

JGoogleDataPicasaPhoto setTime (int $time)

int $time: New photo time

setTitle (line 246)

Method to set the title of the photo

return: The object for method chaining
since: 12.3
access: public

JGoogleDataPicasaPhoto setTitle (string $title)

string $title: New photo title

Inherited Methods

Inherited From JGoogleData

JGoogleData::__construct()
JGoogleData::authenticate()
JGoogleData::getOption()
JGoogleData::isAuthenticated()
JGoogleData::listGetData()
JGoogleData::query()
JGoogleData::safeXML()
JGoogleData::setOption()