Référence de la classe JGoogleDataPicasaAlbum

Graphe d'héritage de JGoogleDataPicasaAlbum:

Fonctions membres publiques
	__construct (SimpleXMLElement $xml, Registry $options=null, JGoogleAuth $auth=null)
	delete ($match=' *')
	getLink ($type='edit')
	getTitle ()
	getSummary ()
	getLocation ()
	getAccess ()
	getTime ()
	setTitle ($title)
	setSummary ($summary)
	setLocation ($location)
	setAccess ($access)
	setTime ($time)
	save ($match=' *')
	refresh ()
	listPhotos ()
	upload ($file, $title='', $summary='')
Fonctions membres publiques hérités de JGoogleData
	__construct (Registry $options=null, JGoogleAuth $auth=null)
	authenticate ()
	isAuthenticated ()
	getOption ($key)
	setOption ($key, $value)

Fonctions membres protégées
	getMime ($file)
Fonctions membres protégées hérités de JGoogleData
	listGetData ($url, $maxpages=1, $token=null)
	query ($url, $data=null, $headers=null, $method='get')

Attributs protégés
	$xml
Attributs protégés hérités de JGoogleData
	$options
	$auth

Membres hérités additionnels
Fonctions membres protégées statiques hérités de JGoogleData
static	safeXml ($data)

Description détaillée

Google Picasa data class for the Joomla Platform.

Depuis

3.1.4

Obsolète:

4.0 Use the joomla/google package via Composer instead

Documentation des constructeurs et destructeur

__construct()

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

Constructor.

Paramètres

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

Depuis

3.1.4

Références $options.

Documentation des fonctions membres

delete()

delete

(

$match = '*'

)

Method to delete a Picasa album

Paramètres

mixed

$match

Check for most up to date album

Renvoie

boolean Success or failure.

Depuis

3.1.4

Exceptions

Exception
RuntimeException
UnexpectedValueException

Références $url, et null.

getAccess()

getAccess

(

)

Method to get the access level of the album

Renvoie

string Album access level

Depuis

3.1.4

getLink()

getLink

(

$type = 'edit'

)

Method to get the album link

Paramètres

string

$type

Type of link to return

Renvoie

string Link or false on failure

Depuis

3.1.4

Références $link, et $type.

getLocation()

getLocation

(

)

Method to get the location of the album

Renvoie

string Album location

Depuis

3.1.4

getMime()

getMime (   $file )

protected

Add photo

Paramètres

string

$file

Filename

Renvoie

mixed Data from Google

Depuis

3.1.4

Exceptions

UnexpectedValueException

Références $file.

getSummary()

getSummary

(

)

Method to get the summary of the album

Renvoie

string Album summary

Depuis

3.1.4

getTime()

getTime

(

)

Method to get the time of the album

Renvoie

double Album time

Depuis

3.1.4

getTitle()

getTitle

(

)

Method to get the title of the album

Renvoie

string Album title

Depuis

3.1.4

listPhotos()

listPhotos

(

)

Method to retrieve a list of Picasa Photos

Renvoie

mixed Data from Google

Depuis

3.1.4

Exceptions

UnexpectedValueException

Références $item, $items, $url, et null.

refresh()

refresh

(

)

Refresh Picasa Album

Renvoie

mixed Data from Google

Depuis

3.1.4

Exceptions

UnexpectedValueException

Références $url, et null.

save()

save

(

$match = '*'

)

Method to modify a Picasa Album

Paramètres

string

$match

Optional eTag matching parameter

Renvoie

mixed Data from Google.

Depuis

3.1.4

Exceptions

Exception

Références $url.

setAccess()

setAccess

(

$access

)

Method to set the access level of the album

Paramètres

string

$access

New album access

Renvoie

JGoogleDataPicasaAlbum The object for method chaining

Depuis

3.1.4

setLocation()

setLocation

(

$location

)

Method to set the location of the album

Paramètres

string

$location

New album location

Renvoie

JGoogleDataPicasaAlbum The object for method chaining

Depuis

3.1.4

Références $location.

setSummary()

setSummary

(

$summary

)

Method to set the summary of the album

Paramètres

string

$summary

New album summary

Renvoie

JGoogleDataPicasaAlbum The object for method chaining

Depuis

3.1.4

setTime()

setTime

(

$time

)

Method to set the time of the album

Paramètres

int

$time

New album time

Renvoie

JGoogleDataPicasaAlbum The object for method chaining

Depuis

3.1.4

setTitle()

setTitle

(

$title

)

Method to set the title of the album

Paramètres

string

$title

New album title

Renvoie

JGoogleDataPicasaAlbum The object for method chaining

Depuis

3.1.4

Références $title.

upload()

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

Add photo

Paramètres

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

Renvoie

mixed Data from Google

Depuis

3.1.4

Exceptions

RuntimeException

Références $data, $file, $title, $type, et jimport().

Documentation des champs

$xml

$xml

protected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• google/data/picasa/album.php