Moodle  2.2.1
http://www.collinsharper.com
Zend_Gdata_Photos Class Reference
Inheritance diagram for Zend_Gdata_Photos:
Collaboration diagram for Zend_Gdata_Photos:

Public Member Functions

 __construct ($client=null, $applicationId= 'MyCompany-MyApp-1.0')
 getUserFeed ($userName=null, $location=null)
 getAlbumFeed ($location=null)
 getPhotoFeed ($location=null)
 getUserEntry ($location)
 getAlbumEntry ($location)
 getPhotoEntry ($location)
 getTagEntry ($location)
 getCommentEntry ($location)
 insertAlbumEntry ($album, $uri=null)
 insertPhotoEntry ($photo, $uri=null)
 insertTagEntry ($tag, $uri=null)
 insertCommentEntry ($comment, $uri=null)
 deleteAlbumEntry ($album, $catch)
 deletePhotoEntry ($photo, $catch)
 deleteCommentEntry ($comment, $catch)
 deleteTagEntry ($tag, $catch)

Data Fields

const PICASA_BASE_URI = 'http://picasaweb.google.com/data'
const PICASA_BASE_FEED_URI = 'http://picasaweb.google.com/data/feed'
const AUTH_SERVICE_NAME = 'lh2'
const DEFAULT_PROJECTION = 'api'
const DEFAULT_VISIBILITY = 'all'
const DEFAULT_USER = 'default'
const USER_PATH = 'user'
const ALBUM_PATH = 'albumid'
const PHOTO_PATH = 'photoid'
const COMMUNITY_SEARCH_PATH = 'all'
const FEED_LINK_PATH = 'http://schemas.google.com/g/2005#feed'
const KIND_PATH = 'http://schemas.google.com/g/2005#kind'

Static Public Attributes

static $namespaces

Detailed Description

Definition at line 58 of file Photos.php.


Constructor & Destructor Documentation

__construct ( client = null,
applicationId = 'MyCompany-MyApp-1.0' 
)

Create Zend_Gdata_Photos object

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

Reimplemented from Zend_Gdata.

Definition at line 131 of file Photos.php.

Here is the call graph for this function:


Member Function Documentation

deleteAlbumEntry ( album,
catch 
)

Delete an AlbumEntry.

Parameters:
Zend_Gdata_Photos_AlbumEntry$albumThe album entry to delete.
boolean$catchWhether to catch an exception when modified and re-delete or throw
Returns:
void.
Exceptions:
Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException

Definition at line 471 of file Photos.php.

Here is the call graph for this function:

deleteCommentEntry ( comment,
catch 
)

Delete a CommentEntry.

Parameters:
Zend_Gdata_Photos_CommentEntry$commentThe comment entry to delete.
boolean$catchWhether to catch an exception when modified and re-delete or throw
Returns:
void.
Exceptions:
Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException

Definition at line 529 of file Photos.php.

Here is the call graph for this function:

deletePhotoEntry ( photo,
catch 
)

Delete a PhotoEntry.

Parameters:
Zend_Gdata_Photos_PhotoEntry$photoThe photo entry to delete.
boolean$catchWhether to catch an exception when modified and re-delete or throw
Returns:
void.
Exceptions:
Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException

Definition at line 500 of file Photos.php.

Here is the call graph for this function:

deleteTagEntry ( tag,
catch 
)

Delete a TagEntry.

Parameters:
Zend_Gdata_Photos_TagEntry$tagThe tag entry to delete.
boolean$catchWhether to catch an exception when modified and re-delete or throw
Returns:
void.
Exceptions:
Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException

Definition at line 558 of file Photos.php.

Here is the call graph for this function:

getAlbumEntry ( location)

Retreive a single AlbumEntry object.

Parameters:
mixed$locationThe location for the feed, as a URL or Query.
Returns:
Zend_Gdata_Photos_AlbumEntry
Exceptions:
Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException

Definition at line 265 of file Photos.php.

Here is the call graph for this function:

getAlbumFeed ( location = null)

Retreive AlbumFeed object containing multiple PhotoEntry or TagEntry objects.

Parameters:
mixed$location(optional) The location for the feed, as a URL or Query.
Returns:
Zend_Gdata_Photos_AlbumFeed
Exceptions:
Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException

Definition at line 187 of file Photos.php.

Here is the call graph for this function:

getCommentEntry ( location)

Retreive a single CommentEntry object.

Parameters:
mixed$locationThe location for the feed, as a URL or Query.
Returns:
Zend_Gdata_Photos_CommentEntry
Exceptions:
Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException

Definition at line 340 of file Photos.php.

Here is the call graph for this function:

getPhotoEntry ( location)

Retreive a single PhotoEntry object.

Parameters:
mixed$locationThe location for the feed, as a URL or Query.
Returns:
Zend_Gdata_Photos_PhotoEntry
Exceptions:
Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException

Definition at line 290 of file Photos.php.

Here is the call graph for this function:

getPhotoFeed ( location = null)

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

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

Definition at line 215 of file Photos.php.

Here is the call graph for this function:

getTagEntry ( location)

Retreive a single TagEntry object.

Parameters:
mixed$locationThe location for the feed, as a URL or Query.
Returns:
Zend_Gdata_Photos_TagEntry
Exceptions:
Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException

Definition at line 315 of file Photos.php.

Here is the call graph for this function:

getUserEntry ( location)

Retreive a single UserEntry object.

Parameters:
mixed$locationThe location for the feed, as a URL or Query.
Returns:
Zend_Gdata_Photos_UserEntry
Exceptions:
Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException

Definition at line 240 of file Photos.php.

Here is the call graph for this function:

getUserFeed ( userName = null,
location = null 
)

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

Parameters:
string$userNameThe 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.
Returns:
Zend_Gdata_Photos_UserFeed
Exceptions:
Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException

Definition at line 150 of file Photos.php.

Here is the call graph for this function:

insertAlbumEntry ( album,
uri = null 
)

Create a new album from a AlbumEntry.

Parameters:
Zend_Gdata_Photos_AlbumEntry$albumThe 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.
Returns:
Zend_Gdata_Photos_AlbumEntry The inserted album entry as returned by the server.
Exceptions:
Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException

Definition at line 370 of file Photos.php.

Here is the call graph for this function:

insertCommentEntry ( comment,
uri = null 
)

Create a new comment from a CommentEntry.

Parameters:
Zend_Gdata_Photos_CommentEntry$commentThe comment entry to insert.
string$urlThe URI where the comment should be uploaded to. Alternatively, a PhotoEntry can be provided and the comment will be added to that photo.
Returns:
Zend_Gdata_Photos_CommentEntry The inserted comment entry as returned by the server.
Exceptions:
Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException

Definition at line 446 of file Photos.php.

Here is the call graph for this function:

insertPhotoEntry ( photo,
uri = null 
)

Create a new photo from a PhotoEntry.

Parameters:
Zend_Gdata_Photos_PhotoEntry$photoThe photo to insert.
string$urlThe URI that the photo should be uploaded to. Alternatively, an AlbumEntry can be provided and the photo will be added to that album.
Returns:
Zend_Gdata_Photos_PhotoEntry The inserted photo entry as returned by the server.
Exceptions:
Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException

Definition at line 393 of file Photos.php.

Here is the call graph for this function:

insertTagEntry ( tag,
uri = null 
)

Create a new tag from a TagEntry.

Parameters:
Zend_Gdata_Photos_TagEntry$tagThe tag entry to insert.
string$urlThe URI where the tag should be uploaded to. Alternatively, a PhotoEntry can be provided and the tag will be added to that photo.
Returns:
Zend_Gdata_Photos_TagEntry The inserted tag entry as returned by the server.
Exceptions:
Zend_Gdata_App_Exception
Zend_Gdata_App_HttpException

Definition at line 419 of file Photos.php.

Here is the call graph for this function:


Field Documentation

$namespaces [static]
Initial 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)
    )

Reimplemented from Zend_Gdata.

Definition at line 115 of file Photos.php.

const ALBUM_PATH = 'albumid'

Path to album feeds on the Picasa server.

Definition at line 88 of file Photos.php.

const AUTH_SERVICE_NAME = 'lh2'

Reimplemented from Zend_Gdata.

Definition at line 63 of file Photos.php.

const COMMUNITY_SEARCH_PATH = 'all'

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

Definition at line 98 of file Photos.php.

const DEFAULT_PROJECTION = 'api'

Default projection when interacting with the Picasa server.

Definition at line 68 of file Photos.php.

const DEFAULT_USER = 'default'

The default user to retrieve feeds for.

Definition at line 78 of file Photos.php.

const DEFAULT_VISIBILITY = 'all'

The default visibility to filter events by.

Definition at line 73 of file Photos.php.

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

The path to use for finding links to feeds within entries

Definition at line 103 of file Photos.php.

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

The path to use for the determining type of an entry

Definition at line 108 of file Photos.php.

const PHOTO_PATH = 'photoid'

Path to photo feeds on the Picasa server.

Definition at line 93 of file Photos.php.

const PICASA_BASE_FEED_URI = 'http://picasaweb.google.com/data/feed'

Definition at line 62 of file Photos.php.

const PICASA_BASE_URI = 'http://picasaweb.google.com/data'

Definition at line 61 of file Photos.php.

const USER_PATH = 'user'

Path to the user feed on the Picasa server.

Definition at line 83 of file Photos.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations