Class JGoogleDataPicasaAlbum

Google Picasa data class for the Joomla Platform.

JGoogleData

JGoogleDataPicasaAlbum

Package: Joomla\Platform\Google
Deprecated: 4.0 Use the joomla/google package via Composer instead
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved
License: General Public License version 2 or later; see LICENSE
Since: 12.3
Located at joomla/google/data/picasa/album.php

Methods summary

`public`	# `__construct( SimpleXMLElement $xml, Joomla\Registry\Registry $options = null, JGoogleAuth $auth = null )` Constructor. Constructor. Parameters `$xml` `SimpleXMLElement` - $xml XML from Google `$options` `Joomla\Registry\Registry` - $options Google options object `$auth` `JGoogleAuth` - $auth Google data http client object Since 12.3 Overrides `JGoogleData::__construct`
`public boolean`	# `delete( mixed $match = '*' )` Method to delete a Picasa album Method to delete a Picasa album Parameters `$match` `mixed` - $match Check for most up to date album Returns `boolean` - Success or failure. Throws `Exception` `RuntimeException` `UnexpectedValueException` Since 12.3
`public string`	# `getLink( string $type = 'edit' )` Method to get the album link Method to get the album link Parameters `$type` `string` - $type Type of link to return Returns `string` - Link or false on failure Since 12.3
`public string`	# `getTitle( )` Method to get the title of the album Method to get the title of the album Returns `string` - Album title Since 12.3
`public string`	# `getSummary( )` Method to get the summary of the album Method to get the summary of the album Returns `string` - Album summary Since 12.3
`public string`	# `getLocation( )` Method to get the location of the album Method to get the location of the album Returns `string` - Album location Since 12.3
`public string`	# `getAccess( )` Method to get the access level of the album Method to get the access level of the album Returns `string` - Album access level Since 12.3
`public float`	# `getTime( )` Method to get the time of the album Method to get the time of the album Returns `float` - Album time Since 12.3
`public JGoogleDataPicasaAlbum`	# `setTitle( string $title )` Method to set the title of the album Method to set the title of the album Parameters `$title` `string` - $title New album title Returns `JGoogleDataPicasaAlbum` - The object for method chaining Since 12.3
`public JGoogleDataPicasaAlbum`	# `setSummary( string $summary )` Method to set the summary of the album Method to set the summary of the album Parameters `$summary` `string` - $summary New album summary Returns `JGoogleDataPicasaAlbum` - The object for method chaining Since 12.3
`public JGoogleDataPicasaAlbum`	# `setLocation( string $location )` Method to set the location of the album Method to set the location of the album Parameters `$location` `string` - $location New album location Returns `JGoogleDataPicasaAlbum` - The object for method chaining Since 12.3
`public JGoogleDataPicasaAlbum`	# `setAccess( string $access )` Method to set the access level of the album Method to set the access level of the album Parameters `$access` `string` - $access New album access Returns `JGoogleDataPicasaAlbum` - The object for method chaining Since 12.3
`public JGoogleDataPicasaAlbum`	# `setTime( integer $time )` Method to set the time of the album Method to set the time of the album Parameters `$time` `integer` - $time New album time Returns `JGoogleDataPicasaAlbum` - The object for method chaining Since 12.3
`public mixed`	# `save( string $match = '*' )` Method to modify a Picasa Album Method to modify a Picasa Album Parameters `$match` `string` - $match Optional eTag matching parameter Returns `mixed` - Data from Google. Throws `Exception` Since 12.3
`public mixed`	# `refresh( )` Refresh Picasa Album Refresh Picasa Album Returns `mixed` - Data from Google Throws `UnexpectedValueException` Since 12.3
`public mixed`	# `listPhotos( )` Method to retrieve a list of Picasa Photos Method to retrieve a list of Picasa Photos Returns `mixed` - Data from Google Throws `UnexpectedValueException` Since 12.3
`public mixed`	# `upload( string $file, string $title = '', string $summary = '' )` Add photo Add photo Parameters `$file` `string` - $file Path of file to upload `$title` `string` - $title Title to give to file (defaults to filename) `$summary` `string` - $summary Description of the file Returns `mixed` - Data from Google Throws `RuntimeException` Since 12.3
`protected mixed`	# `getMime( string $file )` Add photo Add photo Parameters `$file` `string` - $file Filename Returns `mixed` - Data from Google Throws `UnexpectedValueException` Since 12.3

Methods inherited from JGoogleData

authenticate(), getOption(), isAuthenticated(), listGetData(), query(), safeXml(), setOption()

Magic methods summary

Properties summary

`protected SimpleXMLElement`	`$xml`	# The album's XML The album's XML Since 12.3

Properties inherited from JGoogleData

$auth, $options

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JGoogleDataPicasaAlbum

Methods summary

Parameters

Since

Overrides

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Returns

Throws

Since

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Methods inherited from JGoogleData

Magic methods summary

Properties summary

Since

Properties inherited from JGoogleData