Docs For Class Picasa_ImageCollection

Description

Represents a collection of images that are retrieved outside of an actual Album.

An Image Collection is very similar to an album but it lacks certain attributes like a formal title and description. The Picasa_ImageCollection class is appropriate if you are retrieving images by date or tag, regardless of the Album they're in.

author: Cameron Hinkle
version: Version 3.0
copyright: Copyright (c) 2007 Cameron Hinkle
since: Version 1.0
license: GNU Public License Version 3

Located in /Picasa/ImageCollection.php (line 23)

Variable Summary

string $author

string $icon

string $id

array $images

string $itemsPerPage

{@link $picasaAuthor

string $startIndex

string $subtitle

string $title

string $totalResults

string $updated

Method Summary

Picasa_ImageCollection __construct ([string $url = null], [ $collectionXml = null], [array $contextArray = null], [boolean $useCache = true], SimpleXMLElement $albums)

string getAuthor ()

string getIcon ()

string getId ()

void getImages ()

Picasa_Author getPicasaAuthor ()

string getSubtitle ()

string getTitle ()

string getUpdated ()

void setAuthor (string $author)

void setIcon (string $icon)

void setId (string $id)

void setImages (array $images)

void setPicasaAuthor (Picasa_Author $picasaAuthor)

void setSubtitle (string $subtitle)

void setTitle (string $title)

void setUpdated (string $updated)

string __toString ()

Variables

string $author (line 32)

The author of the collection.

deprecated: Deprecated since Version 2.0, use $picasaAuthor instead.
access: private

string $icon (line 72)

The URL to the icon for the collection, probably the author's icon.

access: private

string $id (line 40)

The base URL to the feed that was requested.

access: private

array $images (line 64)

An array of Picasa_Image objects.

access: private

string $itemsPerPage (line 116)

since: Version 3.0
access: private

{@link $picasaAuthor (line 89)

A Picasa_Author object for the author of the collection. Not all fields will be filled.

var: Picasa_Author}
since: Version 2.0
access: private

string $startIndex (line 107)

since: Version 3.0
access: private

string $subtitle (line 80)

The subtitle for the collection. Probably blank.

access: private

string $title (line 48)

The title given to the collection. Probably the author's username.

access: private

string $totalResults (line 98)

since: Version 3.0
access: private

string $updated (line 56)

The date and time the collection was requested in UTC time.

access: private

Methods

Constructor __construct (line 270)

Constructs an ImageCollection object from the Picasa XML feed.

throws: Picasa_Exception If the XML suppled through either parameter does not contain valid XML.
access: public

Picasa_ImageCollection __construct ([string $url = null], [ $collectionXml = null], [array $contextArray = null], [boolean $useCache = true], SimpleXMLElement $albums)

string $url: A query URL constructed according to the Picasa API documentation hosted by Google at http://code.google.com/apis/picasaweb/gdata.html#Add_Album_Manual_Web.
SimpleXMLElement $albums: XML describing a Picasa image collection. This can be left blank as long as a URL is specified in the url parameter that returns valid XML for a Picasa image collection. If both are null, a Picasa_Exception is thrown.
array $contextArray: An array that can be passed to stream_context_create() to generate a PHP context. See http://us2.php.net/manual/en/function.stream-context-create.php
boolean $useCache: You can decide not to cache a specific request by passing false here. You may want to do this, for instance, if you're requesting a private feed.
SimpleXMLElement $collectionXml

getAuthor (line 122)

access: public

string getAuthor ()

getIcon (line 162)

access: public

string getIcon ()

getId (line 130)

access: public

string getId ()

getImages (line 154)

access: public

void getImages ()

getPicasaAuthor (line 178)

access: public

Picasa_Author getPicasaAuthor ()

getSubtitle (line 170)

access: public

string getSubtitle ()

getTitle (line 138)

access: public

string getTitle ()

getUpdated (line 146)

access: public

string getUpdated ()

setAuthor (line 187)

access: public

void setAuthor (string $author)

string $author

setIcon (line 232)

access: public

void setIcon (string $icon)

string $icon

setId (line 196)

access: public

void setId (string $id)

string $id

setImages (line 223)

access: public

void setImages (array $images)

array $images

setPicasaAuthor (line 250)

access: public

void setPicasaAuthor (Picasa_Author $picasaAuthor)

Picasa_Author $picasaAuthor

setSubtitle (line 241)

access: public

void setSubtitle (string $subtitle)

string $subtitle

setTitle (line 205)

access: public

void setTitle (string $title)

string $title

setUpdated (line 214)

access: public

void setUpdated (string $updated)

string $updated

__toString (line 340)

Constructs a textual representation of the current instantiation.

access: public

string __toString ()