Docs For Class Picasa

Class Picasa_Album

Description

Holds a Picasa album.

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/Album.php (line 19)

Variable Summary

string $author

string $bytesUsed

string $commentingEnabled

array $comments

array $contextArray

string $editLink

string $gmlPosition

string $icon

string $id

string $idnum

array $images

string $location

string $numComments

int $numphotos

string $photosRemaining

{@link $picasaAuthor

string $published

string $rights

string $subtitle

string $summary

array $tags

string $timestamp

string $title

string $updated

string $weblink

Method Summary

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

string getAuthor ()

int getBytesUsed ()

boolean getCommentingEnabled ()

array getComments ()

string getEditLink ()

string getGmlPosition ()

string getIcon ()

string getId ()

string getIdnum ()

array getImages ()

string getLocation ()

int getNumComments ()

int getNumphotos ()

int getPhotosRemaining ()

Picasa_Author getPicasaAuthor ()

string getPublished ()

string getRights ()

string getSubtitle ()

string getSummary ()

array getTags ()

string getTimestamp ()

string getTitle ()

string getUpdated ()

string getWeblink ()

void setAuthor (string $author)

void setBytesUsed (int $bytesUsed)

void setCommentingEnabled (boolean $commentingEnabled)

void setComments (array $comments)

void setEditLink (string $editLink)

void setGmlPosition (string $gmlPosition)

void setIcon (string $icon)

void setId (string $id)

void setIdnum (string $idnum)

void setImages (array $images)

void setLocation (string $location)

void setNumComments (int $numComments)

void setNumphotos (int $numphotos)

void setPhotosRemaining (int $photosRemaining)

void setPicasaAuthor (Picasa_Author $picasaAuthor)

void setPublished (string $published)

void setRights (string $rights)

void setSubtitle (string $subtitle)

void setSummary (string $summary)

void setTimestamp (string $timestamp)

void setTitle (string $title)

void setUpdated (string $updated)

void setWeblink (string $weblink)

string __toString ()

Variables

string $author (line 38)

The username of the user who uploaded the album.

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

string $bytesUsed (line 179)

The size of the current album with all the photos, in bytes.

since: Version 3.0
access: private

string $commentingEnabled (line 188)

Determines whether or not commenting is allowed on pictures in the album.

since: Version 3.0
access: private

array $comments (line 206)

An array of Picasa_Comment objects, one for each comment in the album.

since: Version 3.0
access: private

array $contextArray (line 29)

An array that can be passed to stream_create_context() to get a context. This context array is used rather than just an auth token because the context array holds both the auth token and the type of authentication that was performed. The context can be passed as a parameter when instantiating a Picasa object to make the instantiation authenticated.

access: private

string $editLink (line 215)

The link to use when editing the album.

since: Version 3.0
access: private

string $gmlPosition (line 161)

The location that the photos in the album were taken in GML format.

link: http://en.wikipedia.org/wiki/Geography_Markup_Language
since: Version 3.0
access: private

string $icon (line 110)

The URL of the album's cover (160px x 160px).

access: private

string $id (line 46)

The URL of the image's page on Picasa Web.

access: private

string $idnum (line 118)

A numberic value assigned to the album by Picasa, unique across all Picasa albums.

access: private

array $images (line 102)

An array of Picasa_Image objects representing each photo in the album.

access: private

string $location (line 94)

The location that the album is listed as being taken at.

access: private

string $numComments (line 197)

The number of comments made for all photos in the album.

since: Version 3.0
access: private

int $numphotos (line 134)

The number of photos in the album.

access: private

string $photosRemaining (line 170)

The number of photos that can still be uploaded to the album without reaching the album's limit.

since: Version 3.0
access: private

{@link $picasaAuthor (line 142)

A Picasa_Author object representing the album's author.

var: Picasa_Author}
access: private

string $published (line 62)

The date the album was originally published.

access: private

string $rights (line 86)

Indicates whether the album is public or private.

access: private

string $subtitle (line 126)

A description of the album, entered by the author.

access: private

string $summary (line 78)

It's unclear what this field is for. It is likely blank.

access: private

array $tags (line 151)

An array of Picasa_Tag objects representing all tags found in the album.

since: Version 2.0
access: private

string $timestamp (line 224)

The number of miliseconds after January 1st, 1970 that the image was taken.

since: Version 3.0
access: private

string $title (line 54)

The image's title, as set by the author.

access: private

string $updated (line 70)

The date that the album was last updated.

access: private

string $weblink (line 232)

The URL to album PicasaWeb.

access: private

Methods

Constructor __construct (line 682)

Constructs an Album object.

When called, this method will fill out each private member of the Album object based on XML returned from Picasa's Atom feed. It will also create a Picasa_Image object for each image in the Album by passing XML for each image into the Picasa_Image constructor.

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

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

string $url: The URL of the Picasa query to retrieve the XML from. See http://code.google.com/apis/picasaweb/gdata.html for information on how to format the URL. If null, it is assumed that $albums param has been supplied.
SimpleXMLElement $albums: XML for constructing the object. If null, it is assumed that the URL to the Atom feed has been supplied. 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.

getAuthor (line 239)

access: public

string getAuthor ()

getBytesUsed (line 395)

access: public

int getBytesUsed ()

getCommentingEnabled (line 403)

access: public

boolean getCommentingEnabled ()

getComments (line 419)

access: public

array getComments ()

getEditLink (line 433)

access: public

string getEditLink ()

getGmlPosition (line 379)

access: public

string getGmlPosition ()

getIcon (line 326)

access: public

string getIcon ()

getId (line 247)

access: public

string getId ()

getIdnum (line 334)

access: public

string getIdnum ()

getImages (line 307)

The $images feild can somtimes be null because it's not always included in the XML used to create some objects. If that is the case, query the album feed using Picasa::getAlbumById() to get the images in the album. This is done when the client tries to access the images array so that it's not done if it's not requested.

access: public

array getImages ()

getLocation (line 295)

access: public

string getLocation ()

getNumComments (line 411)

access: public

int getNumComments ()

getNumphotos (line 350)

access: public

int getNumphotos ()

getPhotosRemaining (line 387)

access: public

int getPhotosRemaining ()

getPicasaAuthor (line 358)

access: public

Picasa_Author getPicasaAuthor ()

getPublished (line 263)

access: public

string getPublished ()

getRights (line 287)

access: public

string getRights ()

getSubtitle (line 342)

access: public

string getSubtitle ()

getSummary (line 279)

access: public

string getSummary ()

getTags (line 366)

access: public

array getTags ()

getTimestamp (line 441)

access: public

string getTimestamp ()

getTitle (line 255)

access: public

string getTitle ()

getUpdated (line 271)

access: public

string getUpdated ()

getWeblink (line 449)

access: public

string getWeblink ()

setAuthor (line 458)

access: public

void setAuthor (string $author)

string $author

setBytesUsed (line 602)

access: public

void setBytesUsed (int $bytesUsed)

int $bytesUsed

setCommentingEnabled (line 611)

access: public

void setCommentingEnabled (boolean $commentingEnabled)

boolean $commentingEnabled

setComments (line 629)

access: public

void setComments (array $comments)

array $comments

setEditLink (line 639)

access: public

void setEditLink (string $editLink)

string $editLink

setGmlPosition (line 584)

access: public

void setGmlPosition (string $gmlPosition)

string $gmlPosition

setIcon (line 539)

access: public

void setIcon (string $icon)

string $icon

setId (line 467)

access: public

void setId (string $id)

string $id

setIdnum (line 548)

access: public

void setIdnum (string $idnum)

string $idnum

setImages (line 530)

access: public

void setImages (array $images)

array $images

setLocation (line 521)

access: public

void setLocation (string $location)

string $location

setNumComments (line 620)

access: public

void setNumComments (int $numComments)

int $numComments

setNumphotos (line 566)

access: public

void setNumphotos (int $numphotos)

int $numphotos

setPhotosRemaining (line 593)

access: public

void setPhotosRemaining (int $photosRemaining)

int $photosRemaining

setPicasaAuthor (line 575)

access: public

void setPicasaAuthor (Picasa_Author $picasaAuthor)

Picasa_Author $picasaAuthor

setPublished (line 485)

access: public

void setPublished (string $published)

string $published

setRights (line 512)

access: public

void setRights (string $rights)

string $rights

setSubtitle (line 557)

access: public

void setSubtitle (string $subtitle)

string $subtitle

setSummary (line 503)

access: public

void setSummary (string $summary)

string $summary

setTimestamp (line 648)

access: public

void setTimestamp (string $timestamp)

string $timestamp

setTitle (line 476)

access: public

void setTitle (string $title)

string $title

setUpdated (line 494)

access: public

void setUpdated (string $updated)

string $updated

setWeblink (line 657)

access: public

void setWeblink (string $weblink)

string $weblink

__toString (line 797)

Constructs a textual representation of the current instantiation.

access: public

string __toString ()

Documentation generated on Tue, 02 Jun 2009 14:51:48 -0700 by phpDocumentor 1.4.1