Docs For Class Picasa

Description

Holds a Picasa user.

Not all fields are guaranteed to be filled. Name and Uri will likely always contain a valid value. This class should certainly be called "User" instead, but it's way too late to change it now.

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

Variable Summary

string $name

string $nickname

string $thumbnail

string $uri

string $user

Method Summary

static array getAuthorArray ([string $url = null], [ $xml = null], [array $contextArray = null], [boolean $useCache = true])

Picasa_Author __construct ([ $author = null])

string getName ()

string getNickname ()

string getThumbnail ()

string getUri ()

string getUser ()

void setName (string $name)

void setNickname (string $nickname)

void setThumbnail (string $thumbnail)

void setUri (string $uri)

void setUser (string $user)

string __toString ()

Variables

string $name (line 27)

The registered name of the user.

access: private

string $nickname (line 51)

The user's Picasa nickname.

access: private

string $thumbnail (line 59)

The address of an image selected by the user as their thumbnail.

access: private

string $uri (line 35)

The address of their main page on Picasa.

access: private

string $user (line 43)

The username of the user.

access: private

Methods

static method getAuthorArray (line 210)

Constructs an array of Picasa_Author objects based on the XML taken from either the $xml parameter or from the contents of $url.

return: An array of Picasa_Author objects representing all authors in the requested feed.
see: http://php.net/simplexml
throws: Picasa_Exception If the XML passed (through either parameter) could not be used to construct a SimpleXMLElement.
access: public

static array getAuthorArray ([string $url = null], [ $xml = null], [array $contextArray = null], [boolean $useCache = true])

string $url: A URL pointing to a Picasa Atom feed that has zero or more "entry" nodes represeing a Picasa author. Optional, the default is null. If this parameter is null, the method will try to get the XML content from the $xml parameter directly.
SimpleXMLElement $xml: XML from a Picasa Atom feed that has zero or more "entry" nodes represeing a Picasa author. Optional, the default is null. If the $url parameter is null and the $xml parameter is 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.

Constructor __construct (line 153)

Constructs a Picasa_Author object from XML. It's important to remember that several of the fields in any Picasa_Author object will be null or blank. It depends on what type of feed you're requesting. It's best to do trial and error before relying on a field to be populated.

access: public

Picasa_Author __construct ([ $author = null])

string $author: XML representing the Picasa user, most likely retrieved from an Album or Image object.

getName (line 65)

access: public

string getName ()

getNickname (line 89)

access: public

string getNickname ()

getThumbnail (line 97)

access: public

string getThumbnail ()

getUri (line 73)

access: public

string getUri ()

getUser (line 81)

access: public

string getUser ()

setName (line 106)

access: public

void setName (string $name)

string $name

setNickname (line 133)

access: public

void setNickname (string $nickname)

string $nickname

setThumbnail (line 142)

access: public

void setThumbnail (string $thumbnail)

string $thumbnail

setUri (line 115)

access: public

void setUri (string $uri)

string $uri

setUser (line 124)

access: public

void setUser (string $user)

string $user

__toString (line 179)

Constructs a textual representation of the current instantiation.

access: public

string __toString ()

Class Picasa_Author