Docs For Class JGoogleDataPicasaAlbum

Description

Google Picasa data class for the Joomla Platform.

since: 12.3

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

JGoogleData
   |
   --JGoogleDataPicasaAlbum

Variable Summary

SimpleXMLElement $xml

Method Summary

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

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

string getAccess ()

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

string getLocation ()

mixed getMIME (string $file)

string getSummary ()

double getTime ()

string getTitle ()

mixed listPhotos ()

mixed refresh ()

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

JGoogleDataPicasaAlbum setAccess (string $access)

JGoogleDataPicasaAlbum setLocation (string $location)

JGoogleDataPicasaAlbum setSummary (string $summary)

JGoogleDataPicasaAlbum setTime (int $time)

JGoogleDataPicasaAlbum setTitle (string $title)

mixed upload (string $file, [string $title = ''], [string $summary = ''])

Variables

SimpleXMLElement $xml (line 25)

var: The album'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

JGoogleDataPicasaAlbum __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 album

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

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

mixed $match: Check for most up to date album

getAccess (line 163)

Method to get the access level of the album

return: Album access level
since: 12.3
access: public

string getAccess ()

getLink (line 106)

Method to get the album link

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

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

string $type: Type of link to return

getLocation (line 151)

Method to get the location of the album

return: Album location
since: 12.3
access: public

string getLocation ()

getMIME (line 430)

Add photo

return: Data from Google
since: 12.3
throws: UnexpectedValueException
access: protected

mixed getMIME (string $file)

string $file: Filename

getSummary (line 139)

Method to get the summary of the album

return: Album summary
since: 12.3
access: public

string getSummary ()

getTime (line 175)

Method to get the time of the album

return: Album time
since: 12.3
access: public

double getTime ()

getTitle (line 127)

Method to get the title of the album

return: Album title
since: 12.3
access: public

string getTitle ()

listPhotos (line 337)

Method to retrieve a list of Picasa Photos

return: Data from Google
since: 12.3
throws: UnexpectedValueException
access: public

mixed listPhotos ()

refresh (line 313)

Refresh Picasa Album

return: Data from Google
since: 12.3
throws: UnexpectedValueException
access: public

mixed refresh ()

save (line 269)

Method to modify a Picasa Album

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

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

string $match: Optional eTag matching parameter

setAccess (line 237)

Method to set the access level of the album

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

JGoogleDataPicasaAlbum setAccess (string $access)

string $access: New album access

setLocation (line 221)

Method to set the location of the album

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

JGoogleDataPicasaAlbum setLocation (string $location)

string $location: New album location

setSummary (line 205)

Method to set the summary of the album

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

JGoogleDataPicasaAlbum setSummary (string $summary)

string $summary: New album summary

setTime (line 253)

Method to set the time of the album

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

JGoogleDataPicasaAlbum setTime (int $time)

int $time: New album time

setTitle (line 189)

Method to set the title of the album

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

JGoogleDataPicasaAlbum setTitle (string $title)

string $title: New album title

upload (line 378)

Add photo

return: Data from Google
since: 12.3
throws: RuntimeException
access: public

mixed upload (string $file, [string $title = ''], [string $summary = ''])

string $file: Path of file to upload
string $title: Title to give to file (defaults to filename)
string $summary: Description of the file

Inherited Methods

Inherited From JGoogleData

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