Gdata/Photos/AlbumQuery.php

Show: PublicProtectedPrivateinherited
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Gdata  
Subpackage
Photos  
Version
$Id: AlbumQuery.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Gdata_Photos_AlbumQuery

Package: Zend\Gdata\Photos
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.

Parent(s)
\Zend_Gdata_Photos_UserQuery < \Zend_Gdata_Query
Children
\Zend_Gdata_Photos_PhotoQuery
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedstring $_albumId = null
The ID of the album to query for.

Mutually exclusive with AlbumName.

Default valuenullDetails
Type
string
>VPropertyprotectedstring $_albumName = null
The name of the album to query for.

Mutually exclusive with AlbumId.

Default valuenullDetails
Type
string
>VPropertyprotectedstring $_category = null
Default valuenullDetails
Type
string
Inherited_from
\Zend_Gdata_Query::$$_category  
Inherited_from
\Zend_Gdata_Photos_UserQuery::$$_category  
>VPropertyprotectedstring $_defaultFeedUri = null
Default valuenullDetails
Type
string
Inherited_from
\Zend_Gdata_Query::$$_defaultFeedUri  
Inherited_from
\Zend_Gdata_Photos_UserQuery::$$_defaultFeedUri  
>VPropertyprotectedarray $_params = array()
Default valuearray()Details
Type
array
Inherited_from
\Zend_Gdata_Query::$$_params  
Inherited_from
\Zend_Gdata_Photos_UserQuery::$$_params  
>VPropertyprotectedstring $_projection = 'api'
inherited
Indicates the format of data returned in Atom feeds.
Inherited from: \Zend_Gdata_Photos_UserQuery::$$_projection

Can be either 'api' or 'base'. Default value is 'api'.

Default value'api'Details
Type
string
Inherited_from
\Zend_Gdata_Photos_UserQuery::$$_projection  
>VPropertyprotectedstring $_type = 'feed'
inherited
Indicates whether to request a feed or entry in queries.
Inherited from: \Zend_Gdata_Photos_UserQuery::$$_type

Default value is 'feed';

Default value'feed'Details
Type
string
Inherited_from
\Zend_Gdata_Photos_UserQuery::$$_type  
>VPropertyprotectedstring $_url = null
inherited
Base URL TODO: Add setters and getters
Inherited from: \Zend_Gdata_Query::$$_url\Zend_Gdata_Photos_UserQuery::$$_url
Default valuenullDetails
Type
string
Inherited_from
\Zend_Gdata_Query::$$_url  
Inherited_from
\Zend_Gdata_Photos_UserQuery::$$_url  
>VPropertyprotectedstring $_user = \Zend_Gdata_Photos::DEFAULT_USER
inherited
A string which, if not null, indicates which user should be retrieved by this query.
Inherited from: \Zend_Gdata_Photos_UserQuery::$$_user

If null, the default user will be used instead.

Default value\Zend_Gdata_Photos::DEFAULT_USERDetails
Type
string
Inherited_from
\Zend_Gdata_Photos_UserQuery::$$_user  

Methods

methodpublic__construct() : void
inherited

Create a new Query object with default values.

Inherited from: \Zend_Gdata_Photos_UserQuery::__construct()
methodpublic__get( $name) : void
Parameters
NameTypeDescription
$name
methodpublic__set( $name,  $val) : void
Parameters
NameTypeDescription
$name
$val
methodpublicgetAccess() : string
inherited

Get the visibility filter for entries returned.

Inherited from: \Zend_Gdata_Photos_UserQuery::getAccess()
Returns
TypeDescription
stringThe visibility to filter by, or null for the default user.
Details
See
\setAccess  
methodpublicgetAlbumId() : string

Get the album ID which is to be returned.

Returns
TypeDescription
stringThe ID of the album to retrieve.
Details
See
\setAlbum  
methodpublicgetAlbumName() : string

Get the album name which is to be returned.

Returns
TypeDescription
stringThe name of the album to retrieve.
Details
See
\setAlbumName  
methodpublicgetAlt() : string
Returns
TypeDescription
stringrss or atom
methodpublicgetAuthor() : string
Returns
TypeDescription
stringauthor
methodpublicgetImgMax() : string
inherited

Get the maximum image size filter for entries returned.

Inherited from: \Zend_Gdata_Photos_UserQuery::getImgMax()
Returns
TypeDescription
stringThe image size size to filter by, or null if no filter is to be applied.
Details
See
\setImgMax  
methodpublicgetKind() : string
inherited

Get the kind of entries to be returned.

Inherited from: \Zend_Gdata_Photos_UserQuery::getKind()
Returns
TypeDescription
stringThe kind to filter by, or null if no filter is to be applied.
Details
See
\setKind  
methodpublicgetMaxResults() : int
Returns
TypeDescription
intmaxResults
methodpublicgetParam(string $name) : void
Parameters
NameTypeDescription
$namestring
methodpublicgetProjection() : string
inherited

Gets the format of data in returned in Atom feeds.

Inherited from: \Zend_Gdata_Photos_UserQuery::getProjection()
Returns
TypeDescription
stringprojection
Details
See
\setProjection  
methodpublicgetPublishedMax() : string
Returns
TypeDescription
stringpublishedMax
methodpublicgetPublishedMin() : string
Returns
TypeDescription
stringpublishedMin
methodpublicgetQuery() : string
Returns
TypeDescription
stringquery
methodpublicgetQueryString() : string
Returns
TypeDescription
stringquerystring
methodpublicgetQueryUrl( $incomingUri = '') : string

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

Parameters
NameTypeDescription
$incomingUri
Returns
TypeDescription
stringA URL generated based on the state of this query.
Throws
ExceptionDescription
\Zend_Gdata_App_InvalidArgumentException
methodpublicgetStartIndex() : int
Returns
TypeDescription
intstartIndex
methodpublicgetTag() : string
inherited

Get the tag filter for entries returned.

Inherited from: \Zend_Gdata_Photos_UserQuery::getTag()
Returns
TypeDescription
stringThe tag to filter by, or null if no filter is to be applied.
Details
See
\setTag  
methodpublicgetThumbsize() : string
inherited

Get the thumbnail size filter for entries returned.

Inherited from: \Zend_Gdata_Photos_UserQuery::getThumbsize()
Returns
TypeDescription
stringThe thumbnail size to filter by, or null if no filter is to be applied.
Details
See
\setThumbsize  
methodpublicgetType() : string
inherited

Gets the type of data in returned in queries.

Inherited from: \Zend_Gdata_Photos_UserQuery::getType()
Returns
TypeDescription
stringtype
Details
See
\setType  
methodpublicgetUpdatedMax() : string
Returns
TypeDescription
stringupdatedMax
methodpublicgetUpdatedMin() : string
Returns
TypeDescription
stringupdatedMin
methodpublicgetUser() : string
inherited

Get the user which is to be returned.

Inherited from: \Zend_Gdata_Photos_UserQuery::getUser()
Returns
TypeDescription
stringThe visibility to retrieve.
Details
See
\setUser  
methodpublicsetAccess(string $value) : void
inherited

Set the visibility filter for entries returned.

Inherited from: \Zend_Gdata_Photos_UserQuery::setAccess()

Only entries which match this value will be returned. If null or unset, the default value will be used instead.

Valid values are 'all' (default), 'public', and 'private'.

Parameters
NameTypeDescription
$valuestring

The visibility to filter by, or null to use the default value.

methodpublicsetAlbumId(string $value) : \Zend_Gdata_Photos_AlbumQuery

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.

Parameters
NameTypeDescription
$valuestring

The ID of the album to retrieve, or null to clear.

Returns
TypeDescription
\Zend_Gdata_Photos_AlbumQueryThe query object.
methodpublicsetAlbumName(string $value) : \Zend_Gdata_Photos_AlbumQuery

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.

Parameters
NameTypeDescription
$valuestring

The name of the album to retrieve, or null to clear.

Returns
TypeDescription
\Zend_Gdata_Photos_AlbumQueryThe query object.
methodpublicsetAlt(string $value) : \Zend_Gdata_Query
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetAuthor(string $value) : \Zend_Gdata_Query
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetCategory(string $value) : \Zend_Gdata_Query
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetImgMax(string $value) : void
inherited

Set the maximum image size for entries returned.

Inherited from: \Zend_Gdata_Photos_UserQuery::setImgMax()

Only entries which match this value will be returned. If null or unset, this filter will not be applied.

See http://code.google.com/apis/picasaweb/reference.html#Parameters for a list of valid values.

Parameters
NameTypeDescription
$valuestring

The image size to filter by, or null if no filter is to be applied.

methodpublicsetKind(string $value) : void
inherited

Set the kind of entries that are returned.

Inherited from: \Zend_Gdata_Photos_UserQuery::setKind()

Only entries which match this value will be returned. If null or unset, this filter will not be applied.

See http://code.google.com/apis/picasaweb/reference.html#Parameters for a list of valid values.

Parameters
NameTypeDescription
$valuestring

The kind to filter by, or null if no filter is to be applied.

methodpublicsetMaxResults(int $value) : \Zend_Gdata_Query
Parameters
NameTypeDescription
$valueint
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetParam(string $name, string $value) : \Zend_Gdata_Query
Parameters
NameTypeDescription
$namestring
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetProjection(string $value) : \Zend_Gdata_Photos_UserQuery
inherited

Set's the format of data returned in Atom feeds.

Inherited from: \Zend_Gdata_Photos_UserQuery::setProjection()

Can be either 'api' or 'base'. Normally, 'api' will be desired. Default is 'api'.

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_Photos_UserQueryProvides a fluent interface
methodpublicsetPublishedMax(string $value) : \Zend_Gdata_Query
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetPublishedMin(string $value) : \Zend_Gdata_Query
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetQuery(string $value) : \Zend_Gdata_Query
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetStartIndex(int $value) : \Zend_Gdata_Query
Parameters
NameTypeDescription
$valueint
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetTag(string $value) : void
inherited

Set the tag for entries that are returned.

Inherited from: \Zend_Gdata_Photos_UserQuery::setTag()

Only entries which match this value will be returned. If null or unset, this filter will not be applied.

See http://code.google.com/apis/picasaweb/reference.html#Parameters for a list of valid values.

Parameters
NameTypeDescription
$valuestring

The tag to filter by, or null if no filter is to be applied.

methodpublicsetThumbsize(string $value) : void
inherited

Set the thumbnail size filter for entries returned.

Inherited from: \Zend_Gdata_Photos_UserQuery::setThumbsize()

Only entries which match this value will be returned. If null or unset, this filter will not be applied.

See http://code.google.com/apis/picasaweb/reference.html#Parameters for a list of valid values.

Parameters
NameTypeDescription
$valuestring

The thumbnail size to filter by, or null if no filter is to be applied.

methodpublicsetType(string $value) : \Zend_Gdata_Photos_UserQuery
inherited

Set's the type of data returned in queries.

Inherited from: \Zend_Gdata_Photos_UserQuery::setType()

Can be either 'feed' or 'entry'. Normally, 'feed' will be desired. Default is 'feed'.

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_Photos_UserQueryProvides a fluent interface
methodpublicsetUpdatedMax(string $value) : \Zend_Gdata_Query
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetUpdatedMin(string $value) : \Zend_Gdata_Query
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetUser(string $value) : void
inherited

Set the user to query for.

Inherited from: \Zend_Gdata_Photos_UserQuery::setUser()

When set, this user's feed will be returned. If not set or null, the default user's feed will be returned instead.

Parameters
NameTypeDescription
$valuestring

The user to retrieve, or null for the default user.

Documentation was generated by phpDocumentor 2.0.0a12.