## Zend_Gdata_Photos

Description

Service class for interacting with the Google Photos Data API.

Like other service classes in this module, this class provides access via an HTTP client to Google servers for working with entries and feeds.

- copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- link: http://code.google.com/apis/picasaweb/gdata.html
- license: New BSD License

Located in /Gdata/Photos.php (line 58)

    Zend_Gdata_App
       |
       --Zend_Gdata
          |
          --Zend_Gdata_Photos

Class Constant Summary
ALBUM_PATH = 'albumid'
AUTH_SERVICE_NAME = 'lh2'
COMMUNITY_SEARCH_PATH = 'all'
DEFAULT_PROJECTION = 'api'
DEFAULT_USER = 'default'
DEFAULT_VISIBILITY = 'all'
FEED_LINK_PATH = 'http://schemas.google.com/g/2005#feed'
KIND_PATH = 'http://schemas.google.com/g/2005#kind'
PHOTO_PATH = 'photoid'
PICASA_BASE_FEED_URI = 'http://picasaweb.google.com/data/feed'
PICASA_BASE_URI = 'http://picasaweb.google.com/data'
USER_PATH = 'user'
Variable Summary
static array $namespaces
Method Summary
Zend_Gdata_Photos __construct ([Zend_Http_Client $client = null], [string $applicationId = 'MyCompany-MyApp-1.0'])
void. deleteAlbumEntry (Zend_Gdata_Photos_AlbumEntry $album, boolean $catch)
void. deleteCommentEntry (Zend_Gdata_Photos_CommentEntry $comment, boolean $catch)
void. deletePhotoEntry (Zend_Gdata_Photos_PhotoEntry $photo, boolean $catch)
void. deleteTagEntry (Zend_Gdata_Photos_TagEntry $tag, boolean $catch)
Zend_Gdata_Photos_AlbumEntry getAlbumEntry (mixed $location)
Zend_Gdata_Photos_AlbumFeed getAlbumFeed ([mixed $location = null])
Zend_Gdata_Photos_CommentEntry getCommentEntry (mixed $location)
Zend_Gdata_Photos_PhotoEntry getPhotoEntry (mixed $location)
Zend_Gdata_Photos_PhotoFeed getPhotoFeed ([mixed $location = null])
Zend_Gdata_Photos_TagEntry getTagEntry (mixed $location)
Zend_Gdata_Photos_UserEntry getUserEntry (mixed $location)
Zend_Gdata_Photos_UserFeed getUserFeed ([string $userName = null], [mixed $location = null])
Zend_Gdata_Photos_AlbumEntry insertAlbumEntry (Zend_Gdata_Photos_AlbumEntry $album, [ $uri = null], string $url)
Zend_Gdata_Photos_CommentEntry insertCommentEntry (Zend_Gdata_Photos_CommentEntry $comment, [ $uri = null], string $url)
Zend_Gdata_Photos_PhotoEntry insertPhotoEntry (Zend_Gdata_Photos_PhotoEntry $photo, [ $uri = null], string $url)
Zend_Gdata_Photos_TagEntry insertTagEntry (Zend_Gdata_Photos_TagEntry $tag, [ $uri = null], string $url)
Variables
static array $namespaces = array(
array('gphoto', 'http://schemas.google.com/photos/2007', 1, 0),array('photo','http://www.pheed.com/pheed/',1,0),array('exif','http://schemas.google.com/photos/exif/2007',1,0),array('georss','http://www.georss.org/georss',1,0),array('gml','http://www.opengis.net/gml',1,0),array('media','http://search.yahoo.com/mrss/',1,0)) (line 115)

Namespaces used for Zend_Gdata_Photos

- access: public

Redefinition of:

Zend_Gdata::$namespaces
  Namespaces used for Gdata data

#### Inherited Variables

Inherited from Zend_Gdata

> Zend_Gdata::$_defaultPostUri
> Zend_Gdata::$_httpClient
> Zend_Gdata::$_registeredPackages
> Zend_Gdata::$_staticHttpClient

Inherited from Zend_Gdata_App

> Zend_Gdata_App::$_gzipEnabled
> Zend_Gdata_App::$_httpMethodOverride
> Zend_Gdata_App::$_majorProtocolVersion
> Zend_Gdata_App::$_maxRedirects
> Zend_Gdata_App::$_minorProtocolVersion
> Zend_Gdata_App::$_useObjectMapping
> Zend_Gdata_App::$_verboseExceptionMessages

Methods
Constructor __construct (line 131)

Create Zend_Gdata_Photos object

- access: public

Zend_Gdata_Photos __construct ([Zend_Http_Client $client = null], [string $applicationId = 'MyCompany-MyApp-1.0'])

- Zend_Http_Client $client: (optional) The HTTP client to use when when communicating with the servers.
- string $applicationId: The identity of the app in the form of Company-AppName-Version

Redefinition of:

Zend_Gdata::__construct()
  Create Gdata object

deleteAlbumEntry (line 471)

Delete an AlbumEntry.

- throws: Zend_Gdata_App_HttpException
- throws: Zend_Gdata_App_Exception
- access: public

void. deleteAlbumEntry (Zend_Gdata_Photos_AlbumEntry $album, boolean $catch)

- Zend_Gdata_Photos_AlbumEntry $album: The album entry to delete.
- boolean $catch: Whether to catch an exception when modified and re-delete or throw

deleteCommentEntry (line 529)

Delete a CommentEntry.

- throws: Zend_Gdata_App_HttpException
- throws: Zend_Gdata_App_Exception
- access: public

void. deleteCommentEntry (Zend_Gdata_Photos_CommentEntry $comment, boolean $catch)

- Zend_Gdata_Photos_CommentEntry $comment: The comment entry to delete.
- boolean $catch: Whether to catch an exception when modified and re-delete or throw

deletePhotoEntry (line 500)

Delete a PhotoEntry.

- throws: Zend_Gdata_App_HttpException
- throws: Zend_Gdata_App_Exception
- access: public

void. deletePhotoEntry (Zend_Gdata_Photos_PhotoEntry $photo, boolean $catch)

- Zend_Gdata_Photos_PhotoEntry $photo: The photo entry to delete.
- boolean $catch: Whether to catch an exception when modified and re-delete or throw

deleteTagEntry (line 558)

Delete a TagEntry.

- throws: Zend_Gdata_App_HttpException
- throws: Zend_Gdata_App_Exception
- access: public

void. deleteTagEntry (Zend_Gdata_Photos_TagEntry $tag, boolean $catch)

- Zend_Gdata_Photos_TagEntry $tag: The tag entry to delete.
- boolean $catch: Whether to catch an exception when modified and re-delete or throw

getAlbumEntry (line 265)

Retreive a single AlbumEntry object.

- throws: Zend_Gdata_App_HttpException
- throws: Zend_Gdata_App_Exception
- access: public

Zend_Gdata_Photos_AlbumEntry getAlbumEntry (mixed $location)

- mixed $location: The location for the feed, as a URL or Query.

getAlbumFeed (line 187)

Retreive AlbumFeed object containing multiple PhotoEntry or TagEntry objects.

- throws: Zend_Gdata_App_HttpException
- throws: Zend_Gdata_App_Exception
- access: public

Zend_Gdata_Photos_AlbumFeed getAlbumFeed ([mixed $location = null])

- mixed $location: (optional) The location for the feed, as a URL or Query.

getCommentEntry (line 340)

Retreive a single CommentEntry object.

- throws: Zend_Gdata_App_HttpException
- throws: Zend_Gdata_App_Exception
- access: public

Zend_Gdata_Photos_CommentEntry getCommentEntry (mixed $location)

- mixed $location: The location for the feed, as a URL or Query.

getPhotoEntry (line 290)

Retreive a single PhotoEntry object.

- throws: Zend_Gdata_App_HttpException
- throws: Zend_Gdata_App_Exception
- access: public

Zend_Gdata_Photos_PhotoEntry getPhotoEntry (mixed $location)

- mixed $location: The location for the feed, as a URL or Query.

getPhotoFeed (line 215)

Retreive PhotoFeed object containing comments and tags associated with a given photo.

- throws: Zend_Gdata_App_HttpException
- throws: Zend_Gdata_App_Exception
- access: public

Zend_Gdata_Photos_PhotoFeed getPhotoFeed ([mixed $location = null])

- mixed $location: (optional) The location for the feed, as a URL or Query. If not specified, the community search feed will be returned instead.

getTagEntry (line 315)

Retreive a single TagEntry object.

- throws: Zend_Gdata_App_HttpException
- throws: Zend_Gdata_App_Exception
- access: public

Zend_Gdata_Photos_TagEntry getTagEntry (mixed $location)

- mixed $location: The location for the feed, as a URL or Query.

getUserEntry (line 240)

Retreive a single UserEntry object.

- throws: Zend_Gdata_App_HttpException
- throws: Zend_Gdata_App_Exception
- access: public

Zend_Gdata_Photos_UserEntry getUserEntry (mixed $location)

- mixed $location: The location for the feed, as a URL or Query.

getUserFeed (line 150)

Retrieve a UserFeed containing AlbumEntries, PhotoEntries and TagEntries associated with a given user.

- throws: Zend_Gdata_App_HttpException
- throws: Zend_Gdata_App_Exception
- access: public

Zend_Gdata_Photos_UserFeed getUserFeed ([string $userName = null], [mixed $location = null])

- string $userName: The userName of interest
- mixed $location: (optional) The location for the feed, as a URL or Query. If not provided, a default URL will be used instead.

insertAlbumEntry (line 370)

Create a new album from a AlbumEntry.

- return: The inserted album entry as returned by the server.
- throws: Zend_Gdata_App_HttpException
- throws: Zend_Gdata_App_Exception
- access: public

Zend_Gdata_Photos_AlbumEntry insertAlbumEntry (Zend_Gdata_Photos_AlbumEntry $album, [ $uri = null], string $url)

- Zend_Gdata_Photos_AlbumEntry $album: The album entry to insert.
- string $url: (optional) The URI that the album should be uploaded to. If null, the default album creation URI for this domain will be used.
- $uri

insertCommentEntry (line 446)

Create a new comment from a CommentEntry.

- return: The inserted comment entry as returned by the server.
- throws: Zend_Gdata_App_HttpException
- throws: Zend_Gdata_App_Exception
- access: public

Zend_Gdata_Photos_CommentEntry insertCommentEntry (Zend_Gdata_Photos_CommentEntry $comment, [ $uri = null], string $url)

- Zend_Gdata_Photos_CommentEntry $comment: The comment entry to insert.
- string $url: The URI where the comment should be uploaded to. Alternatively, a PhotoEntry can be provided and the comment will be added to that photo.
- $uri

insertPhotoEntry (line 393)

Create a new photo from a PhotoEntry.

- return: The inserted photo entry as returned by the server.
- throws: Zend_Gdata_App_HttpException
- throws: Zend_Gdata_App_Exception
- access: public

Zend_Gdata_Photos_PhotoEntry insertPhotoEntry (Zend_Gdata_Photos_PhotoEntry $photo, [ $uri = null], string $url)

- Zend_Gdata_Photos_PhotoEntry $photo: The photo to insert.
- string $url: The URI that the photo should be uploaded to. Alternatively, an AlbumEntry can be provided and the photo will be added to that album.
- $uri

insertTagEntry (line 419)

Create a new tag from a TagEntry.

- return: The inserted tag entry as returned by the server.
- throws: Zend_Gdata_App_HttpException
- throws: Zend_Gdata_App_Exception
- access: public

Zend_Gdata_Photos_TagEntry insertTagEntry (Zend_Gdata_Photos_TagEntry $tag, [ $uri = null], string $url)

- Zend_Gdata_Photos_TagEntry $tag: The tag entry to insert.
- string $url: The URI where the tag should be uploaded to. Alternatively, a PhotoEntry can be provided and the tag will be added to that photo.
- $uri

#### Inherited Methods

Inherited From Zend_Gdata

> Zend_Gdata::__construct()
> Zend_Gdata::getEntry()
> Zend_Gdata::getFeed()
> Zend_Gdata::import()
> Zend_Gdata::isAuthenticated()
> Zend_Gdata::performHttpRequest()

Inherited From Zend_Gdata_App

> Zend_Gdata_App::__construct()
> Zend_Gdata_App::delete()
> Zend_Gdata_App::enableRequestDebugLogging()
> Zend_Gdata_App::generateIfMatchHeaderData()
> Zend_Gdata_App::get()
> Zend_Gdata_App::getEntry()
> Zend_Gdata_App::getFeed()
> Zend_Gdata_App::getGzipEnabled()
> Zend_Gdata_App::getHttpClient()
> Zend_Gdata_App::getHttpMethodOverride()
> Zend_Gdata_App::getMajorProtocolVersion()
> Zend_Gdata_App::getMaxRedirects()
> Zend_Gdata_App::getMinorProtocolVersion()
> Zend_Gdata_App::getNextFeed()
> Zend_Gdata_App::getPreviousFeed()
> Zend_Gdata_App::getStaticHttpClient()
> Zend_Gdata_App::getVerboseExceptionMessages()
> Zend_Gdata_App::import()
> Zend_Gdata_App::importFile()
> Zend_Gdata_App::importString()
> Zend_Gdata_App::importUrl()
> Zend_Gdata_App::insertEntry()
> Zend_Gdata_App::performHttpRequest()
> Zend_Gdata_App::post()
> Zend_Gdata_App::prepareRequest()
> Zend_Gdata_App::put()
> Zend_Gdata_App::registerPackage()
> Zend_Gdata_App::retrieveAllEntriesForFeed()
> Zend_Gdata_App::setGzipEnabled()
> Zend_Gdata_App::setHttpClient()
> Zend_Gdata_App::setHttpMethodOverride()
> Zend_Gdata_App::setMajorProtocolVersion()
> Zend_Gdata_App::setMaxRedirects()
> Zend_Gdata_App::setMinorProtocolVersion()
> Zend_Gdata_App::setStaticHttpClient()
> Zend_Gdata_App::setVerboseExceptionMessages()
> Zend_Gdata_App::updateEntry()
> Zend_Gdata_App::useObjectMapping()
> Zend_Gdata_App::usingObjectMapping()
> Zend_Gdata_App::__call()

Class Constants
ALBUM_PATH = 'albumid' (line 88)

Path to album feeds on the Picasa server.

AUTH_SERVICE_NAME = 'lh2' (line 63)
COMMUNITY_SEARCH_PATH = 'all' (line 98)

The path to the community search feed on the Picasa server.

DEFAULT_PROJECTION = 'api' (line 68)

Default projection when interacting with the Picasa server.

DEFAULT_USER = 'default' (line 78)

The default user to retrieve feeds for.

DEFAULT_VISIBILITY = 'all' (line 73)

The default visibility to filter events by.

FEED_LINK_PATH = 'http://schemas.google.com/g/2005#feed' (line 103)

The path to use for finding links to feeds within entries

KIND_PATH = 'http://schemas.google.com/g/2005#kind' (line 108)

The path to use for the determining type of an entry

PHOTO_PATH = 'photoid' (line 93)

Path to photo feeds on the Picasa server.

PICASA_BASE_FEED_URI = 'http://picasaweb.google.com/data/feed' (line 62)
PICASA_BASE_URI = 'http://picasaweb.google.com/data' (line 61)
USER_PATH = 'user' (line 83)

Path to the user feed on the Picasa server.

#### Inherited Constants

Inherited from Zend_Gdata

> Zend_Gdata::AUTH_SERVICE_NAME

Inherited from Zend_Gdata_App

> Zend_Gdata_App::DEFAULT_MAJOR_PROTOCOL_VERSION
> Zend_Gdata_App::DEFAULT_MINOR_PROTOCOL_VERSION

Documentation generated on Tue, 26 Oct 2010 20:09:04 +0400 by phpDocumentor 1.4.2