Photo

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 photo

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

1.0

throws

\Exception

\RuntimeException

\UnexpectedValueException

Arguments

$match

mixedCheck for most up to date photo

Response

booleanSuccess or failure.

getAccess

Method to get the access level of the photo

getAccess() : string
since

1.0

Response

stringPhoto access level

getHeight

Method to get the height of the photo

getHeight() : integer
since

1.0

Response

integerPhoto height

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.

getSize

Method to get the size of the photo

getSize() : integer
since

1.0

Response

integerPhoto size

getSummary

Method to get the summary of the photo

getSummary() : string
since

1.0

Response

stringPhoto description

getThumbnails

Method to get the photo's thumbnails

getThumbnails() : array
since

1.0

Response

arrayAn array of thumbnails

getTime

Method to get the time of the photo

getTime() : float
since

1.0

Response

floatPhoto time

getTitle

Method to get the title of the photo

getTitle() : string
since

1.0

Response

stringPhoto title

getUrl

Method to get the photo's URL

getUrl() : string
since

1.0

Response

stringLink

getWidth

Method to get the width of the photo

getWidth() : integer
since

1.0

Response

integerPhoto width

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

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 photo data

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 Photo

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 photo

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

1.0

Arguments

$access

stringNew photo access level

Response

\Joomla\Google\Data\Picasa\PhotoThe 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 photo

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

1.0

Arguments

$summary

stringNew photo description

Response

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

setTime

Method to set the time of the photo

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

1.0

Arguments

$time

integerNew photo time

Response

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

setTitle

Method to set the title of the photo

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

1.0

Arguments

$title

stringNew photo title

Response

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

Properties

xml

The photo'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