class JGoogleDataPicasaAlbum extends JGoogleData

Google Picasa data class for the Joomla Platform.

Methods

__construct( SimpleXMLElement $xml, Registry $options = null, JGoogleAuth $auth = null)

Constructor.

boolean
authenticate()

Method to authenticate to Google

boolean
isAuthenticated()

Check authentication

mixed
getOption( string $key)

Get an option from the JGoogleData instance.

setOption( string $key, mixed $value)

Set an option for the JGoogleData instance.

boolean
delete( mixed $match = '*')

Method to delete a Picasa album

string
getLink( string $type = 'edit')

Method to get the album link

string
getTitle()

Method to get the title of the album

string
getSummary()

Method to get the summary of the album

string
getLocation()

Method to get the location of the album

string
getAccess()

Method to get the access level of the album

double
getTime()

Method to get the time of the album

setTitle( string $title)

Method to set the title of the album

setSummary( string $summary)

Method to set the summary of the album

setLocation( string $location)

Method to set the location of the album

setAccess( string $access)

Method to set the access level of the album

setTime( int $time)

Method to set the time of the album

mixed
save( string $match = '*')

Method to modify a Picasa Album

mixed
refresh()

Refresh Picasa Album

mixed
listPhotos()

Method to retrieve a list of Picasa Photos

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

Add photo

Details

__construct( SimpleXMLElement $xml, Registry $options = null, JGoogleAuth $auth = null)

Constructor.

Parameters

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

boolean authenticate()

Method to authenticate to Google

Return Value

boolean True on success.

boolean isAuthenticated()

Check authentication

Return Value

boolean True if authenticated.

mixed getOption( string $key)

Get an option from the JGoogleData instance.

Parameters

string $key The name of the option to get.

Return Value

mixed The option value.

JGoogleData setOption( string $key, mixed $value)

Set an option for the JGoogleData instance.

Parameters

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

Return Value

JGoogleData This object for method chaining.

boolean delete( mixed $match = '*')

Method to delete a Picasa album

Parameters

mixed $match Check for most up to date album

Return Value

boolean Success or failure.

Exceptions

Exception
RuntimeException
UnexpectedValueException

Method to get the album link

Parameters

string $type Type of link to return

Return Value

string Link or false on failure

string getTitle()

Method to get the title of the album

Return Value

string Album title

string getSummary()

Method to get the summary of the album

Return Value

string Album summary

string getLocation()

Method to get the location of the album

Return Value

string Album location

string getAccess()

Method to get the access level of the album

Return Value

string Album access level

double getTime()

Method to get the time of the album

Return Value

double Album time

JGoogleDataPicasaAlbum setTitle( string $title)

Method to set the title of the album

Parameters

string $title New album title

Return Value

JGoogleDataPicasaAlbum The object for method chaining

JGoogleDataPicasaAlbum setSummary( string $summary)

Method to set the summary of the album

Parameters

string $summary New album summary

Return Value

JGoogleDataPicasaAlbum The object for method chaining

JGoogleDataPicasaAlbum setLocation( string $location)

Method to set the location of the album

Parameters

string $location New album location

Return Value

JGoogleDataPicasaAlbum The object for method chaining

JGoogleDataPicasaAlbum setAccess( string $access)

Method to set the access level of the album

Parameters

string $access New album access

Return Value

JGoogleDataPicasaAlbum The object for method chaining

JGoogleDataPicasaAlbum setTime( int $time)

Method to set the time of the album

Parameters

int $time New album time

Return Value

JGoogleDataPicasaAlbum The object for method chaining

mixed save( string $match = '*')

Method to modify a Picasa Album

Parameters

string $match Optional eTag matching parameter

Return Value

mixed Data from Google.

Exceptions

Exception

mixed refresh()

Refresh Picasa Album

Return Value

mixed Data from Google

Exceptions

UnexpectedValueException

mixed listPhotos()

Method to retrieve a list of Picasa Photos

Return Value

mixed Data from Google

Exceptions

UnexpectedValueException

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

Add photo

Parameters

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

Return Value

mixed Data from Google

Exceptions

RuntimeException