Album

Extends \Joomla\Google\Data

Google Picasa data class for the Joomla Framework.

deprecated
since

1.0

deprecated

The joomla/google package is deprecated

Methods

__construct

Constructor.

__construct(array $options = array(), \Joomla\Google\Auth $auth = null) 
inherited
since

1.0

Arguments

$options

arrayGoogle options object.

$auth

\Joomla\Google\AuthGoogle data http client object.

authenticate

Method to authenticate to Google

authenticate() : boolean
inherited
since

1.0

Response

booleanTrue on success.

delete

Method to delete a Picasa album

delete(mixed $match = '*') : boolean
since

1.0

throws

\Exception

\RuntimeException

\UnexpectedValueException

Arguments

$match

mixedCheck for most up to date album

Response

booleanSuccess or failure.

getAccess

Method to get the access level of the album

getAccess() : string
since

1.0

Response

stringAlbum access level

getLocation

Method to get the location of the album

getLocation() : string
since

1.0

Response

stringAlbum location

getMime

Add photo

getMime(string $file) : mixed
since

1.0

throws

\UnexpectedValueException

Arguments

$file

stringFilename

Response

mixedData from Google

getOption

Get an option from the Data instance.

getOption(string $key) : mixed
inherited
since

1.0

Arguments

$key

stringThe name of the option to get.

Response

mixedThe option value.

getSummary

Method to get the summary of the album

getSummary() : string
since

1.0

Response

stringAlbum summary

getTime

Method to get the time of the album

getTime() : float
since

1.0

Response

floatAlbum time

getTitle

Method to get the title of the album

getTitle() : string
since

1.0

Response

stringAlbum title

isAuthenticated

Check authentication

isAuthenticated() : boolean
inherited
since

1.0

Response

booleanTrue if authenticated.

listGetData

Method to retrieve a list of data

listGetData(array $url, integer $maxpages = 1, string $token = null) : mixed
inherited
since

1.0

throws

\UnexpectedValueException

Arguments

$url

arrayURL to GET

$maxpages

integerMaximum number of pages to return

$token

stringNext page token

Response

mixedData from Google

listPhotos

Method to retrieve a list of Picasa Photos

listPhotos() : mixed
since

1.0

throws

\UnexpectedValueException

Response

mixedData from Google

query

Method to retrieve data from Google

query(string $url, mixed $data = null, array $headers = null, string $method = 'get') : mixed
inherited
since

1.0

Arguments

$url

stringThe URL for the request.

$data

mixedThe data to include in the request.

$headers

arrayThe headers to send with the request.

$method

stringThe type of http request to send.

Response

mixedData from Google.

refresh

Refresh Picasa Album

refresh() : mixed
since

1.0

Response

mixedData from Google

safeXml

Method to validate XML

safeXml(string $data) : \SimpleXMLElement
inherited static
since

1.0

throws

\UnexpectedValueException

Arguments

$data

stringXML data to be parsed

Response

\SimpleXMLElementXMLElement of parsed data

save

Method to modify a Picasa Album

save(string $match = '*') : mixed
since

1.0

throws

\Exception

\RuntimeException

Arguments

$match

stringOptional eTag matching parameter

Response

mixedData from Google.

setAccess

Method to set the access level of the album

setAccess(string $access) : \Joomla\Google\Data\Picasa\Album
since

1.0

Arguments

$access

stringNew album access

Response

\Joomla\Google\Data\Picasa\AlbumThe object for method chaining

setLocation

Method to set the location of the album

setLocation(string $location) : \Joomla\Google\Data\Picasa\Album
since

1.0

Arguments

$location

stringNew album location

Response

\Joomla\Google\Data\Picasa\AlbumThe object for method chaining

setOption

Set an option for the Data instance.

setOption(string $key, mixed $value) : \Joomla\Google\Data
inherited
since

1.0

Arguments

$key

stringThe name of the option to set.

$value

mixedThe option value to set.

Response

\Joomla\Google\DataThis object for method chaining.

setSummary

Method to set the summary of the album

setSummary(string $summary) : \Joomla\Google\Data\Picasa\Album
since

1.0

Arguments

$summary

stringNew album summary

Response

\Joomla\Google\Data\Picasa\AlbumThe object for method chaining

setTime

Method to set the time of the album

setTime(integer $time) : \Joomla\Google\Data\Picasa\Album
since

1.0

Arguments

$time

integerNew album time

Response

\Joomla\Google\Data\Picasa\AlbumThe object for method chaining

setTitle

Method to set the title of the album

setTitle(string $title) : \Joomla\Google\Data\Picasa\Album
since

1.0

Arguments

$title

stringNew album title

Response

\Joomla\Google\Data\Picasa\AlbumThe object for method chaining

upload

Add photo

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

1.0

throws

\RuntimeException

\UnexpectedValueException

Arguments

$file

stringPath of file to upload

$title

stringTitle to give to file (defaults to filename)

$summary

stringDescription of the file

Response

mixedData from Google

Properties

xml

The album's XML

since

1.0

Type(s)

\SimpleXMLElement

options

Options for the Google data object.

inherited
since

1.0

Type(s)

array

auth

Authentication client for the Google data object.

inherited
since

1.0

Type(s)

\Joomla\Google\Auth