Gdata/Photos.php

Show:

inherited

Classes
- \Zend_Gdata_Photos

Table of Contents

Zend Framework

LICENSE This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Gdata
Subpackage: Photos
Version: $Id$

\Zend_Gdata_Photos
jump to top

Package: Zend_Gdata\Photos

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.

Parent(s): \Zend_Gdata < \Zend_Gdata_App
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Link: http://code.google.com/apis/picasaweb/gdata.html

Constants

 
                PICASA_BASE_URI
                = 'https://picasaweb.google.com/data'

 
                PICASA_BASE_FEED_URI
                = 'https://picasaweb.google.com/data/feed'

 
                AUTH_SERVICE_NAME
                = 'lh2'

 
                DEFAULT_PROJECTION
                = 'api'

Default projection when interacting with the Picasa server.

 
                DEFAULT_VISIBILITY
                = 'all'

The default visibility to filter events by.

 
                DEFAULT_USER
                = 'default'

The default user to retrieve feeds for.

 
                USER_PATH
                = 'user'

Path to the user feed on the Picasa server.

 
                ALBUM_PATH
                = 'albumid'

Path to album feeds on the Picasa server.

 
                PHOTO_PATH
                = 'photoid'

Path to photo feeds on the Picasa server.

 
                COMMUNITY_SEARCH_PATH
                = 'all'

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

 
                FEED_LINK_PATH
                = 'http://schemas.google.com/g/2005#feed'

The path to use for finding links to feeds within entries

 
                KIND_PATH
                = 'http://schemas.google.com/g/2005#kind'

The path to use for the determining type of an entry

Properties

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))

static

Namespaces used for Zend_Gdata_Photos

Default value

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))

Details

Type: array

Methods

__construct(\Zend_Http_Client $client = null, string $applicationId = 'MyCompany-MyApp-1.0') : void

Create Zend_Gdata_Photos object

Parameters

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

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

Delete an AlbumEntry.

Parameters

Name	Type	Description
$album	\Zend_Gdata_Photos_AlbumEntry	The album entry to delete.
$catch	boolean	Whether to catch an exception when `modified and re-delete or throw`

Returns

Type	Description
\void.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException

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

Delete a CommentEntry.

Parameters

Name	Type	Description
$comment	\Zend_Gdata_Photos_CommentEntry	The comment entry to delete.
$catch	boolean	Whether to catch an exception when `modified and re-delete or throw`

Returns

Type	Description
\void.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException

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

Delete a PhotoEntry.

Parameters

Name	Type	Description
$photo	\Zend_Gdata_Photos_PhotoEntry	The photo entry to delete.
$catch	boolean	Whether to catch an exception when `modified and re-delete or throw`

Returns

Type	Description
\void.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException

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

Delete a TagEntry.

Parameters

Name	Type	Description
$tag	\Zend_Gdata_Photos_TagEntry	The tag entry to delete.
$catch	boolean	Whether to catch an exception when `modified and re-delete or throw`

Returns

Type	Description
\void.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException

getAlbumEntry(mixed $location) : \Zend_Gdata_Photos_AlbumEntry

Retreive a single AlbumEntry object.

Parameters

Name	Type	Description
$location	mixed	The location for the feed, as a URL or Query.

Returns

Type	Description
\Zend_Gdata_Photos_AlbumEntry

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException

getAlbumFeed(mixed $location = null) : \Zend_Gdata_Photos_AlbumFeed

Retreive AlbumFeed object containing multiple PhotoEntry or TagEntry objects.

Parameters

Name	Type	Description
$location	mixed	(optional) The location for the feed, as a URL or Query.

Returns

Type	Description
\Zend_Gdata_Photos_AlbumFeed

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException

getCommentEntry(mixed $location) : \Zend_Gdata_Photos_CommentEntry

Retreive a single CommentEntry object.

Parameters

Name	Type	Description
$location	mixed	The location for the feed, as a URL or Query.

Returns

Type	Description
\Zend_Gdata_Photos_CommentEntry

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException

getPhotoEntry(mixed $location) : \Zend_Gdata_Photos_PhotoEntry

Retreive a single PhotoEntry object.

Parameters

Name	Type	Description
$location	mixed	The location for the feed, as a URL or Query.

Returns

Type	Description
\Zend_Gdata_Photos_PhotoEntry

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException

getPhotoFeed(mixed $location = null) : \Zend_Gdata_Photos_PhotoFeed

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

Parameters

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

Returns

Type	Description
\Zend_Gdata_Photos_PhotoFeed

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException

getTagEntry(mixed $location) : \Zend_Gdata_Photos_TagEntry

Retreive a single TagEntry object.

Parameters

Name	Type	Description
$location	mixed	The location for the feed, as a URL or Query.

Returns

Type	Description
\Zend_Gdata_Photos_TagEntry

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException

getUserEntry(mixed $location) : \Zend_Gdata_Photos_UserEntry

Retreive a single UserEntry object.

Parameters

Name	Type	Description
$location	mixed	The location for the feed, as a URL or Query.

Returns

Type	Description
\Zend_Gdata_Photos_UserEntry

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException

getUserFeed(string $userName = null, mixed $location = null) : \Zend_Gdata_Photos_UserFeed

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

Parameters

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

Returns

Type	Description
\Zend_Gdata_Photos_UserFeed

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException

insertAlbumEntry(\Zend_Gdata_Photos_AlbumEntry $album, $uri = null) : \Zend_Gdata_Photos_AlbumEntry

Create a new album from a AlbumEntry.

Parameters

Name	Type	Description
$album	\Zend_Gdata_Photos_AlbumEntry	The album entry to insert.
$uri

Returns

Type	Description
\Zend_Gdata_Photos_AlbumEntry	The inserted album entry as returned by the server.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException

insertCommentEntry(\Zend_Gdata_Photos_CommentEntry $comment, $uri = null) : \Zend_Gdata_Photos_CommentEntry

Create a new comment from a CommentEntry.

Parameters

Name	Type	Description
$comment	\Zend_Gdata_Photos_CommentEntry	The comment entry to insert.
$uri

Returns

Type	Description
\Zend_Gdata_Photos_CommentEntry	The inserted comment entry as returned by the server.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException

insertPhotoEntry(\Zend_Gdata_Photos_PhotoEntry $photo, $uri = null) : \Zend_Gdata_Photos_PhotoEntry

Create a new photo from a PhotoEntry.

Parameters

Name	Type	Description
$photo	\Zend_Gdata_Photos_PhotoEntry	The photo to insert.
$uri

Returns

Type	Description
\Zend_Gdata_Photos_PhotoEntry	The inserted photo entry as returned by the server.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException

insertTagEntry(\Zend_Gdata_Photos_TagEntry $tag, $uri = null) : \Zend_Gdata_Photos_TagEntry

Create a new tag from a TagEntry.

Parameters

Name	Type	Description
$tag	\Zend_Gdata_Photos_TagEntry	The tag entry to insert.
$uri

Returns

Type	Description
\Zend_Gdata_Photos_TagEntry	The inserted tag entry as returned by the server.

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException

Gdata/Photos.php

\Zend_Gdata_Photosjump to top

Constants

Properties

Methods

\Zend_Gdata_Photos
jump to top