Zend/Gdata/Photos.php
Show:
inherited
inherited
Classes
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-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Gdata
- Subpackage
- Photos
- Version
- $Id: Photos.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Gdata_Photos
Package: Zend\Gdata\Photos
Default value
Parameters
Parameters
Returns
Throws
Parameters
Returns
Throws
Parameters
Returns
Throws
Parameters
Returns
Throws
Parameters
Returns
Throws
Parameters
Returns
Throws
Parameters
Returns
Throws
Parameters
Returns
Throws
Parameters
Returns
Throws
Parameters
Returns
Throws
Parameters
Returns
Throws
Parameters
Returns
Throws
Parameters
Returns
Throws
Parameters
Returns
Throws
Parameters
Returns
Throws
Parameters
Returns
Throws
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-2012 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''
static
Namespaces used for Zend_Gdata_Photos
array(
array('gphoto'Details- Type
- array
Methods
__construct(
\Zend_Http_Client $client
=
null, string $applicationId
=
'MyCompany-MyApp-1.0'
)
:
voidCreate Zend_Gdata_Photos object
| 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.
| 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 |
| Type | Description |
|---|---|
| \void. |
| Exception | Description |
|---|---|
| \Zend_Gdata_App_Exception | |
| \Zend_Gdata_App_HttpException |
deleteCommentEntry(
\Zend_Gdata_Photos_CommentEntry $comment, boolean $catch
)
:
\void.Delete a CommentEntry.
| 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 |
| Type | Description |
|---|---|
| \void. |
| Exception | Description |
|---|---|
| \Zend_Gdata_App_Exception | |
| \Zend_Gdata_App_HttpException |
deletePhotoEntry(
\Zend_Gdata_Photos_PhotoEntry $photo, boolean $catch
)
:
\void.Delete a PhotoEntry.
| 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 |
| Type | Description |
|---|---|
| \void. |
| Exception | Description |
|---|---|
| \Zend_Gdata_App_Exception | |
| \Zend_Gdata_App_HttpException |
deleteTagEntry(
\Zend_Gdata_Photos_TagEntry $tag, boolean $catch
)
:
\void.Delete a TagEntry.
| 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 |
| Type | Description |
|---|---|
| \void. |
| Exception | Description |
|---|---|
| \Zend_Gdata_App_Exception | |
| \Zend_Gdata_App_HttpException |
getAlbumEntry(
mixed $location
)
:
\Zend_Gdata_Photos_AlbumEntryRetreive a single AlbumEntry object.
| Name | Type | Description |
|---|---|---|
| $location | mixed | The location for the feed, as a URL or Query. |
| Type | Description |
|---|---|
| \Zend_Gdata_Photos_AlbumEntry |
| Exception | Description |
|---|---|
| \Zend_Gdata_App_Exception | |
| \Zend_Gdata_App_HttpException |
getAlbumFeed(
mixed $location
=
null
)
:
\Zend_Gdata_Photos_AlbumFeedRetreive AlbumFeed object containing multiple PhotoEntry or TagEntry objects.
| Name | Type | Description |
|---|---|---|
| $location | mixed | (optional) The location for the feed, as a URL or Query. |
| Type | Description |
|---|---|
| \Zend_Gdata_Photos_AlbumFeed |
| Exception | Description |
|---|---|
| \Zend_Gdata_App_Exception | |
| \Zend_Gdata_App_HttpException |
getCommentEntry(
mixed $location
)
:
\Zend_Gdata_Photos_CommentEntryRetreive a single CommentEntry object.
| Name | Type | Description |
|---|---|---|
| $location | mixed | The location for the feed, as a URL or Query. |
| Type | Description |
|---|---|
| \Zend_Gdata_Photos_CommentEntry |
| Exception | Description |
|---|---|
| \Zend_Gdata_App_Exception | |
| \Zend_Gdata_App_HttpException |
getPhotoEntry(
mixed $location
)
:
\Zend_Gdata_Photos_PhotoEntryRetreive a single PhotoEntry object.
| Name | Type | Description |
|---|---|---|
| $location | mixed | The location for the feed, as a URL or Query. |
| Type | Description |
|---|---|
| \Zend_Gdata_Photos_PhotoEntry |
| Exception | Description |
|---|---|
| \Zend_Gdata_App_Exception | |
| \Zend_Gdata_App_HttpException |
getPhotoFeed(
mixed $location
=
null
)
:
\Zend_Gdata_Photos_PhotoFeedRetreive PhotoFeed object containing comments and tags associated with a given photo.
| 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. |
| Type | Description |
|---|---|
| \Zend_Gdata_Photos_PhotoFeed |
| Exception | Description |
|---|---|
| \Zend_Gdata_App_Exception | |
| \Zend_Gdata_App_HttpException |
getTagEntry(
mixed $location
)
:
\Zend_Gdata_Photos_TagEntryRetreive a single TagEntry object.
| Name | Type | Description |
|---|---|---|
| $location | mixed | The location for the feed, as a URL or Query. |
| Type | Description |
|---|---|
| \Zend_Gdata_Photos_TagEntry |
| Exception | Description |
|---|---|
| \Zend_Gdata_App_Exception | |
| \Zend_Gdata_App_HttpException |
getUserEntry(
mixed $location
)
:
\Zend_Gdata_Photos_UserEntryRetreive a single UserEntry object.
| Name | Type | Description |
|---|---|---|
| $location | mixed | The location for the feed, as a URL or Query. |
| Type | Description |
|---|---|
| \Zend_Gdata_Photos_UserEntry |
| Exception | Description |
|---|---|
| \Zend_Gdata_App_Exception | |
| \Zend_Gdata_App_HttpException |
getUserFeed(
string $userName
=
null, mixed $location
=
null
)
:
\Zend_Gdata_Photos_UserFeedRetrieve a UserFeed containing AlbumEntries, PhotoEntries and TagEntries associated with a given user.
| 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. |
| Type | Description |
|---|---|
| \Zend_Gdata_Photos_UserFeed |
| Exception | Description |
|---|---|
| \Zend_Gdata_App_Exception | |
| \Zend_Gdata_App_HttpException |
insertAlbumEntry(
\Zend_Gdata_Photos_AlbumEntry $album, $uri
=
null
)
:
\Zend_Gdata_Photos_AlbumEntryCreate a new album from a AlbumEntry.
| Name | Type | Description |
|---|---|---|
| $album | \Zend_Gdata_Photos_AlbumEntry | The album entry to insert. |
| $uri |
| Type | Description |
|---|---|
| \Zend_Gdata_Photos_AlbumEntry | The inserted album entry as returned by the server. |
| Exception | Description |
|---|---|
| \Zend_Gdata_App_Exception | |
| \Zend_Gdata_App_HttpException |
insertCommentEntry(
\Zend_Gdata_Photos_CommentEntry $comment, $uri
=
null
)
:
\Zend_Gdata_Photos_CommentEntryCreate a new comment from a CommentEntry.
| Name | Type | Description |
|---|---|---|
| $comment | \Zend_Gdata_Photos_CommentEntry | The comment entry to insert. |
| $uri |
| Type | Description |
|---|---|
| \Zend_Gdata_Photos_CommentEntry | The inserted comment entry as returned by the server. |
| Exception | Description |
|---|---|
| \Zend_Gdata_App_Exception | |
| \Zend_Gdata_App_HttpException |
insertPhotoEntry(
\Zend_Gdata_Photos_PhotoEntry $photo, $uri
=
null
)
:
\Zend_Gdata_Photos_PhotoEntryCreate a new photo from a PhotoEntry.
| Name | Type | Description |
|---|---|---|
| $photo | \Zend_Gdata_Photos_PhotoEntry | The photo to insert. |
| $uri |
| Type | Description |
|---|---|
| \Zend_Gdata_Photos_PhotoEntry | The inserted photo entry as returned by the server. |
| Exception | Description |
|---|---|
| \Zend_Gdata_App_Exception | |
| \Zend_Gdata_App_HttpException |
insertTagEntry(
\Zend_Gdata_Photos_TagEntry $tag, $uri
=
null
)
:
\Zend_Gdata_Photos_TagEntryCreate a new tag from a TagEntry.
| Name | Type | Description |
|---|---|---|
| $tag | \Zend_Gdata_Photos_TagEntry | The tag entry to insert. |
| $uri |
| Type | Description |
|---|---|
| \Zend_Gdata_Photos_TagEntry | The inserted tag entry as returned by the server. |
| Exception | Description |
|---|---|
| \Zend_Gdata_App_Exception | |
| \Zend_Gdata_App_HttpException |