Gdata/Photos.php

category: Zend
copyright: Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Gdata
subpackage: Photos
version: $Id: Photos.php 23805 2011-03-16 00:55:40Z tjohns $
Classes: Zend_Gdata_Photos

Description

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.

Zend_Gdata_Photos
jump to top

Extends from: Zend_Gdata
category: Zend
copyright: Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
link: http://code.google.com/apis/picasaweb/gdata.html
package: Zend_Gdata
subpackage: Photos
Constants: PICASA_BASE_URI; PICASA_BASE_FEED_URI; AUTH_SERVICE_NAME; DEFAULT_PROJECTION; DEFAULT_VISIBILITY; DEFAULT_USER; USER_PATH; ALBUM_PATH; PHOTO_PATH; COMMUNITY_SEARCH_PATH; FEED_LINK_PATH; KIND_PATH
Properties: $namespaces
Methods: __construct; getUserFeed; getAlbumFeed; getPhotoFeed; getUserEntry; getAlbumEntry; getPhotoEntry; getTagEntry; getCommentEntry; insertAlbumEntry; insertPhotoEntry; insertTagEntry; insertCommentEntry; deleteAlbumEntry; deletePhotoEntry; deleteCommentEntry; deleteTagEntry

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.

Constants

PICASA_BASE_URI
jump to class

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

Details

value: https://picasaweb.google.com/data

PICASA_BASE_FEED_URI
jump to class

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

Details

value: https://picasaweb.google.com/data/feed

AUTH_SERVICE_NAME
jump to class

 AUTH_SERVICE_NAME = 'lh2'

Details

value: lh2

DEFAULT_PROJECTION
jump to class

 DEFAULT_PROJECTION = 'api'

Default projection when interacting with the Picasa server.

Details

value: api

DEFAULT_VISIBILITY
jump to class

 DEFAULT_VISIBILITY = 'all'

The default visibility to filter events by.

Details

value: all

DEFAULT_USER
jump to class

 DEFAULT_USER = 'default'

The default user to retrieve feeds for.

Details

value: default

USER_PATH
jump to class

 USER_PATH = 'user'

Path to the user feed on the Picasa server.

Details

value: user

ALBUM_PATH
jump to class

 ALBUM_PATH = 'albumid'

Path to album feeds on the Picasa server.

Details

value: albumid

PHOTO_PATH
jump to class

 PHOTO_PATH = 'photoid'

Path to photo feeds on the Picasa server.

Details

value: photoid

COMMUNITY_SEARCH_PATH
jump to class

 COMMUNITY_SEARCH_PATH = 'all'

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

Details

value: all

FEED_LINK_PATH
jump to class

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

The path to use for finding links to feeds within entries

Details

value: http://schemas.google.com/g/2005#feed

KIND_PATH
jump to class

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

The path to use for the determining type of an entry

Details

value: http://schemas.google.com/g/2005#kind

Properties

$namespaces
jump to class

array $namespaces = 'array'

Namespaces used for Zend_Gdata_Photos

Details

$namespaces: array
visibility: public
default: array
final: false
static: true

Methods

__construct
jump to class

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

Create Zend_Gdata_Photos object

Arguments

$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

Details

visibility: public
final: false
static: false

deleteAlbumEntry
jump to class

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

Delete an AlbumEntry.

Arguments

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

Output

void.

Details

visibility: public
final: false
static: false
throws
throws

deleteCommentEntry
jump to class

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

Delete a CommentEntry.

Arguments

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

Output

void.

Details

visibility: public
final: false
static: false
throws
throws

deletePhotoEntry
jump to class

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

Delete a PhotoEntry.

Arguments

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

Output

void.

Details

visibility: public
final: false
static: false
throws
throws

deleteTagEntry
jump to class

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

Delete a TagEntry.

Arguments

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

Output

void.

Details

visibility: public
final: false
static: false
throws
throws

getAlbumEntry
jump to class

getAlbumEntry(
          mixed $location
          )
        
        :
        Zend_Gdata_Photos_AlbumEntry

Retreive a single AlbumEntry object.

Arguments

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

Output

Zend_Gdata_Photos_AlbumEntry

Details

visibility: public
final: false
static: false
throws
throws

getAlbumFeed
jump to class

getAlbumFeed(
          mixed $location
              =
              null
          )
        
        :
        Zend_Gdata_Photos_AlbumFeed

Retreive AlbumFeed object containing multiple PhotoEntry or TagEntry objects.

Arguments

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

Output

Zend_Gdata_Photos_AlbumFeed

Details

visibility: public
final: false
static: false
throws
throws

getCommentEntry
jump to class

getCommentEntry(
          mixed $location
          )
        
        :
        Zend_Gdata_Photos_CommentEntry

Retreive a single CommentEntry object.

Arguments

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

Output

Zend_Gdata_Photos_CommentEntry

Details

visibility: public
final: false
static: false
throws
throws

getPhotoEntry
jump to class

getPhotoEntry(
          mixed $location
          )
        
        :
        Zend_Gdata_Photos_PhotoEntry

Retreive a single PhotoEntry object.

Arguments

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

Output

Zend_Gdata_Photos_PhotoEntry

Details

visibility: public
final: false
static: false
throws
throws

getPhotoFeed
jump to class

getPhotoFeed(
          mixed $location
              =
              null
          )
        
        :
        Zend_Gdata_Photos_PhotoFeed

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

Arguments

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

Output

Zend_Gdata_Photos_PhotoFeed

Details

visibility: public
final: false
static: false
throws
throws

getTagEntry
jump to class

getTagEntry(
          mixed $location
          )
        
        :
        Zend_Gdata_Photos_TagEntry

Retreive a single TagEntry object.

Arguments

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

Output

Zend_Gdata_Photos_TagEntry

Details

visibility: public
final: false
static: false
throws
throws

getUserEntry
jump to class

getUserEntry(
          mixed $location
          )
        
        :
        Zend_Gdata_Photos_UserEntry

Retreive a single UserEntry object.

Arguments

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

Output

Zend_Gdata_Photos_UserEntry

Details

visibility: public
final: false
static: false
throws
throws

getUserFeed
jump to class

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

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

Arguments

$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.

Output

Zend_Gdata_Photos_UserFeed

Details

visibility: public
final: false
static: false
throws
throws

insertAlbumEntry
jump to class

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

Create a new album from a AlbumEntry.

Arguments

$album: Zend_Gdata_Photos_AlbumEntry
The album entry to insert.
$uri

Output

Zend_Gdata_Photos_AlbumEntry: The inserted album entry as returned by the server.

Details

visibility: public
final: false
static: false
throws
throws

insertCommentEntry
jump to class

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

Create a new comment from a CommentEntry.

Arguments

$comment: Zend_Gdata_Photos_CommentEntry
The comment entry to insert.
$uri

Output

Zend_Gdata_Photos_CommentEntry: The inserted comment entry as returned by the server.

Details

visibility: public
final: false
static: false
throws
throws

insertPhotoEntry
jump to class

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

Create a new photo from a PhotoEntry.

Arguments

$photo: Zend_Gdata_Photos_PhotoEntry
The photo to insert.
$uri

Output

Zend_Gdata_Photos_PhotoEntry: The inserted photo entry as returned by the server.

Details

visibility: public
final: false
static: false
throws
throws

insertTagEntry
jump to class

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

Create a new tag from a TagEntry.

Arguments

$tag: Zend_Gdata_Photos_TagEntry
The tag entry to insert.
$uri

Output

Zend_Gdata_Photos_TagEntry: The inserted tag entry as returned by the server.

Details

visibility: public
final: false
static: false
throws
throws

API Documentation

Gdata/Photos.php

Description

Zend_Gdata_Photosjump to top

Description

Constants

PICASA_BASE_URIjump to class

Details

PICASA_BASE_FEED_URIjump to class

Details

AUTH_SERVICE_NAMEjump to class

Details

DEFAULT_PROJECTIONjump to class

Details

DEFAULT_VISIBILITYjump to class

Details

DEFAULT_USERjump to class

Details

USER_PATHjump to class

Details

ALBUM_PATHjump to class

Details

PHOTO_PATHjump to class

Details

COMMUNITY_SEARCH_PATHjump to class

Details

FEED_LINK_PATHjump to class

Details

KIND_PATHjump to class

Details

Properties

$namespacesjump to class

Details

Methods

__constructjump to class

Arguments

Details

deleteAlbumEntryjump to class

Arguments

Output

Details

deleteCommentEntryjump to class

Arguments

Output

Details

deletePhotoEntryjump to class

Arguments

Output

Details

deleteTagEntryjump to class

Arguments

Output

Details

getAlbumEntryjump to class

Arguments

Output

Details

getAlbumFeedjump to class

Arguments

Output

Details

getCommentEntryjump to class

Arguments

Output

Details

getPhotoEntryjump to class

Arguments

Output

Details

getPhotoFeedjump to class

Arguments

Output

Details

getTagEntryjump to class

Arguments

Output

Details

getUserEntryjump to class

Arguments

Output

Zend_Gdata_Photos
jump to top

PICASA_BASE_URI
jump to class

PICASA_BASE_FEED_URI
jump to class

AUTH_SERVICE_NAME
jump to class

DEFAULT_PROJECTION
jump to class

DEFAULT_VISIBILITY
jump to class

DEFAULT_USER
jump to class

USER_PATH
jump to class

ALBUM_PATH
jump to class

PHOTO_PATH
jump to class

COMMUNITY_SEARCH_PATH
jump to class

FEED_LINK_PATH
jump to class

KIND_PATH
jump to class

$namespaces
jump to class

__construct
jump to class

deleteAlbumEntry
jump to class

deleteCommentEntry
jump to class

deletePhotoEntry
jump to class

deleteTagEntry
jump to class

getAlbumEntry
jump to class

getAlbumFeed
jump to class

getCommentEntry
jump to class

getPhotoEntry
jump to class

getPhotoFeed
jump to class

getTagEntry
jump to class

getUserEntry
jump to class

getUserFeed
jump to class

insertAlbumEntry
jump to class

insertCommentEntry
jump to class

insertPhotoEntry
jump to class

insertTagEntry
jump to class