Class Zend_Gdata_Photos_AlbumQuery

Description

Assists in constructing album queries for various entries.

Instances of this class can be provided in many places where a URL is required.

For information on submitting queries to a server, see the service class, Zend_Gdata_Photos.

  • copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Gdata/Photos/AlbumQuery.php (line 43)

Zend_Gdata_Query
   |
   --Zend_Gdata_Photos_UserQuery
      |
      --Zend_Gdata_Photos_AlbumQuery
Direct descendents
Class Description
 class Zend_Gdata_Photos_PhotoQuery Assists in constructing queries for comment/tag entries.
Variable Summary
 string $_albumId
 string $_albumName
Method Summary
 string getAlbumId ()
 string getAlbumName ()
 string getQueryUrl ([ $incomingUri = ''])
Variables
string $_albumId = null (line 58)

The ID of the album to query for. Mutually exclusive with AlbumName.

  • access: protected
string $_albumName = null (line 51)

The name of the album to query for. Mutually exclusive with AlbumId.

  • access: protected

Inherited Variables

Inherited from Zend_Gdata_Photos_UserQuery

Zend_Gdata_Photos_UserQuery::$_projection
Zend_Gdata_Photos_UserQuery::$_type
Zend_Gdata_Photos_UserQuery::$_user

Inherited from Zend_Gdata_Query

Zend_Gdata_Query::$_category
Zend_Gdata_Query::$_defaultFeedUri
Zend_Gdata_Query::$_params
Zend_Gdata_Query::$_url
Methods
getAlbumId (line 117)

Get the album ID which is to be returned.

  • return: The ID of the album to retrieve.
  • see: setAlbum
  • access: public
string getAlbumId ()
getAlbumName (line 86)

Get the album name which is to be returned.

string getAlbumName ()
getQueryUrl (line 129)

Returns the URL generated for this query, based on it's current parameters.

  • return: A URL generated based on the state of this query.
  • throws: Zend_Gdata_App_InvalidArgumentException
  • access: public
string getQueryUrl ([ $incomingUri = ''])
  • $incomingUri

Redefinition of:
Zend_Gdata_Photos_UserQuery::getQueryUrl()
Returns the URL generated for this query, based on it's current parameters.

Redefined in descendants as:
setAlbumId (line 103)

Set the album ID to query for. When set, this album's photographs be returned. If not set or null, the default user's feed will be returned instead.

NOTE: Album and AlbumId are mutually exclusive. Setting one will automatically set the other to null.

  • return: The query object.
  • access: public
Zend_Gdata_Photos_AlbumQuery setAlbumId (string $value)
  • string $value: The ID of the album to retrieve, or null to clear.
setAlbumName (line 72)

Set the album name to query for. When set, this album's photographs be returned. If not set or null, the default user's feed will be returned instead.

NOTE: AlbumName and AlbumId are mutually exclusive. Setting one will automatically set the other to null.

  • return: The query object.
  • access: public
Zend_Gdata_Photos_AlbumQuery setAlbumName (string $value)
  • string $value: The name of the album to retrieve, or null to clear.

Inherited Methods

Inherited From Zend_Gdata_Photos_UserQuery

 Zend_Gdata_Photos_UserQuery::__construct()
 Zend_Gdata_Photos_UserQuery::getAccess()
 Zend_Gdata_Photos_UserQuery::getImgMax()
 Zend_Gdata_Photos_UserQuery::getKind()
 Zend_Gdata_Photos_UserQuery::getProjection()
 Zend_Gdata_Photos_UserQuery::getQueryUrl()
 Zend_Gdata_Photos_UserQuery::getTag()
 Zend_Gdata_Photos_UserQuery::getThumbsize()
 Zend_Gdata_Photos_UserQuery::getType()
 Zend_Gdata_Photos_UserQuery::getUser()
 Zend_Gdata_Photos_UserQuery::setAccess()
 Zend_Gdata_Photos_UserQuery::setImgMax()
 Zend_Gdata_Photos_UserQuery::setKind()
 Zend_Gdata_Photos_UserQuery::setProjection()
 Zend_Gdata_Photos_UserQuery::setTag()
 Zend_Gdata_Photos_UserQuery::setThumbsize()
 Zend_Gdata_Photos_UserQuery::setType()
 Zend_Gdata_Photos_UserQuery::setUser()

Inherited From Zend_Gdata_Query

 Zend_Gdata_Query::__construct()
 Zend_Gdata_Query::getAlt()
 Zend_Gdata_Query::getAuthor()
 Zend_Gdata_Query::getCategory()
 Zend_Gdata_Query::getMaxResults()
 Zend_Gdata_Query::getParam()
 Zend_Gdata_Query::getPublishedMax()
 Zend_Gdata_Query::getPublishedMin()
 Zend_Gdata_Query::getQuery()
 Zend_Gdata_Query::getQueryString()
 Zend_Gdata_Query::getQueryUrl()
 Zend_Gdata_Query::getStartIndex()
 Zend_Gdata_Query::getUpdatedMax()
 Zend_Gdata_Query::getUpdatedMin()
 Zend_Gdata_Query::resetParameters()
 Zend_Gdata_Query::setAlt()
 Zend_Gdata_Query::setAuthor()
 Zend_Gdata_Query::setCategory()
 Zend_Gdata_Query::setMaxResults()
 Zend_Gdata_Query::setParam()
 Zend_Gdata_Query::setPublishedMax()
 Zend_Gdata_Query::setPublishedMin()
 Zend_Gdata_Query::setQuery()
 Zend_Gdata_Query::setStartIndex()
 Zend_Gdata_Query::setUpdatedMax()
 Zend_Gdata_Query::setUpdatedMin()
 Zend_Gdata_Query::__get()
 Zend_Gdata_Query::__set()

Documentation generated on Mon, 21 Jun 2010 15:07:10 -0400 by phpDocumentor 1.4.3