Gdata/Photos/AlbumQuery.php

Show:

inherited

Classes
- \Zend_Gdata_Photos_AlbumQuery

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
jump to top

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

string $_albumId = null

The ID of the album to query for.

Mutually exclusive with AlbumName.

Default valuenullDetails

Type: string

string $_albumName = null

The name of the album to query for.

Mutually exclusive with AlbumId.

Default valuenullDetails

Type: string

string $_category = null

inherited

Category for the query

Inherited from: \Zend_Gdata_Query::$$_category \Zend_Gdata_Photos_UserQuery::$$_category

Default valuenullDetails

Type: string
Inherited_from: \Zend_Gdata_Query::$$_category
Inherited_from: \Zend_Gdata_Photos_UserQuery::$$_category

string $_defaultFeedUri = null

inherited

Default URL

Inherited from: \Zend_Gdata_Query::$$_defaultFeedUri \Zend_Gdata_Photos_UserQuery::$$_defaultFeedUri

Default valuenullDetails

Type: string
Inherited_from: \Zend_Gdata_Query::$$_defaultFeedUri
Inherited_from: \Zend_Gdata_Photos_UserQuery::$$_defaultFeedUri

array $_params = array()

inherited

Query parameters.

Inherited from: \Zend_Gdata_Query::$$_params \Zend_Gdata_Photos_UserQuery::$$_params

Default valuearray()Details

Type: array
Inherited_from: \Zend_Gdata_Query::$$_params
Inherited_from: \Zend_Gdata_Photos_UserQuery::$$_params

string $_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

string $_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

string $_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

string $_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

__construct() : void

inherited

Create a new Query object with default values.

Inherited from: \Zend_Gdata_Photos_UserQuery::__construct()

__get( $name) : void

inherited

Inherited from: \Zend_Gdata_Query::__get()\Zend_Gdata_Photos_UserQuery::__get()

Parameters

Name	Type	Description
$name

__set( $name, $val) : void

inherited

Inherited from: \Zend_Gdata_Query::__set()\Zend_Gdata_Photos_UserQuery::__set()

Parameters

Name	Type	Description
$name
$val

getAccess() : string

inherited

Get the visibility filter for entries returned.

Inherited from: \Zend_Gdata_Photos_UserQuery::getAccess()

Returns

Type	Description
string	The visibility to filter by, or null for the default user.

Details

See: \setAccess

getAlbumId() : string

Get the album ID which is to be returned.

Returns

Type	Description
string	The ID of the album to retrieve.

Details

See: \setAlbum

getAlbumName() : string

Get the album name which is to be returned.

Returns

Type	Description
string	The name of the album to retrieve.

Details

See: \setAlbumName

getAlt() : string

inherited

Inherited from: \Zend_Gdata_Query::getAlt()\Zend_Gdata_Photos_UserQuery::getAlt()

Returns

Type	Description
string	rss or atom

getAuthor() : string

inherited

Inherited from: \Zend_Gdata_Query::getAuthor()\Zend_Gdata_Photos_UserQuery::getAuthor()

Returns

Type	Description
string	author

getCategory() : void

inherited

Inherited from: \Zend_Gdata_Query::getCategory()\Zend_Gdata_Photos_UserQuery::getCategory()

getImgMax() : string

inherited

Get the maximum image size filter for entries returned.

Inherited from: \Zend_Gdata_Photos_UserQuery::getImgMax()

Returns

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

Details

See: \setImgMax

getKind() : string

inherited

Get the kind of entries to be returned.

Inherited from: \Zend_Gdata_Photos_UserQuery::getKind()

Returns

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

Details

See: \setKind

getMaxResults() : int

inherited

Inherited from: \Zend_Gdata_Query::getMaxResults()\Zend_Gdata_Photos_UserQuery::getMaxResults()

Returns

Type	Description
int	maxResults

getParam(string $name) : void

inherited

Inherited from: \Zend_Gdata_Query::getParam()\Zend_Gdata_Photos_UserQuery::getParam()

Parameters

Name	Type	Description
$name	string

getProjection() : string

inherited

Gets the format of data in returned in Atom feeds.

Inherited from: \Zend_Gdata_Photos_UserQuery::getProjection()

Returns

Type	Description
string	projection

Details

See: \setProjection

getPublishedMax() : string

inherited

Inherited from: \Zend_Gdata_Query::getPublishedMax()\Zend_Gdata_Photos_UserQuery::getPublishedMax()

Returns

Type	Description
string	publishedMax

getPublishedMin() : string

inherited

Inherited from: \Zend_Gdata_Query::getPublishedMin()\Zend_Gdata_Photos_UserQuery::getPublishedMin()

Returns

Type	Description
string	publishedMin

getQuery() : string

inherited

Inherited from: \Zend_Gdata_Query::getQuery()\Zend_Gdata_Photos_UserQuery::getQuery()

Returns

Type	Description
string	query

getQueryString() : string

inherited

Inherited from: \Zend_Gdata_Query::getQueryString()\Zend_Gdata_Photos_UserQuery::getQueryString()

Returns

Type	Description
string	querystring

getQueryUrl( $incomingUri = '') : string

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

Parameters

Name	Type	Description
$incomingUri

Returns

Type	Description
string	A URL generated based on the state of this query.

Throws

Exception	Description
\Zend_Gdata_App_InvalidArgumentException

getStartIndex() : int

inherited

Inherited from: \Zend_Gdata_Query::getStartIndex()\Zend_Gdata_Photos_UserQuery::getStartIndex()

Returns

Type	Description
int	startIndex

getTag() : string

inherited

Get the tag filter for entries returned.

Inherited from: \Zend_Gdata_Photos_UserQuery::getTag()

Returns

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

Details

See: \setTag

getThumbsize() : string

inherited

Get the thumbnail size filter for entries returned.

Inherited from: \Zend_Gdata_Photos_UserQuery::getThumbsize()

Returns

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

Details

See: \setThumbsize

getType() : string

inherited

Gets the type of data in returned in queries.

Inherited from: \Zend_Gdata_Photos_UserQuery::getType()

Returns

Type	Description
string	type

Details

See: \setType

getUpdatedMax() : string

inherited

Inherited from: \Zend_Gdata_Query::getUpdatedMax()\Zend_Gdata_Photos_UserQuery::getUpdatedMax()

Returns

Type	Description
string	updatedMax

getUpdatedMin() : string

inherited

Inherited from: \Zend_Gdata_Query::getUpdatedMin()\Zend_Gdata_Photos_UserQuery::getUpdatedMin()

Returns

Type	Description
string	updatedMin

getUser() : string

inherited

Get the user which is to be returned.

Inherited from: \Zend_Gdata_Photos_UserQuery::getUser()

Returns

Type	Description
string	The visibility to retrieve.

Details

See: \setUser

resetParameters() : void

inherited

Inherited from: \Zend_Gdata_Query::resetParameters()\Zend_Gdata_Photos_UserQuery::resetParameters()

setAccess(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

Name	Type	Description
$value	string	The visibility to filter by, or null to use the default value.

setAlbumId(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

Name	Type	Description
$value	string	The ID of the album to retrieve, or null to clear.

Returns

Type	Description
\Zend_Gdata_Photos_AlbumQuery	The query object.

setAlbumName(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

Name	Type	Description
$value	string	The name of the album to retrieve, or null to clear.

Returns

Type	Description
\Zend_Gdata_Photos_AlbumQuery	The query object.

setAlt(string $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setAlt()\Zend_Gdata_Photos_UserQuery::setAlt()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setAuthor(string $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setAuthor()\Zend_Gdata_Photos_UserQuery::setAuthor()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setCategory(string $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setCategory()\Zend_Gdata_Photos_UserQuery::setCategory()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setImgMax(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

Name	Type	Description
$value	string	The image size to filter by, or null if no filter is to be applied.

setKind(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

Name	Type	Description
$value	string	The kind to filter by, or null if no filter is to be applied.

setMaxResults(int $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setMaxResults()\Zend_Gdata_Photos_UserQuery::setMaxResults()

Parameters

Name	Type	Description
$value	int

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setParam(string $name, string $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setParam()\Zend_Gdata_Photos_UserQuery::setParam()

Parameters

Name	Type	Description
$name	string
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setProjection(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

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Photos_UserQuery	Provides a fluent interface

setPublishedMax(string $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setPublishedMax()\Zend_Gdata_Photos_UserQuery::setPublishedMax()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setPublishedMin(string $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setPublishedMin()\Zend_Gdata_Photos_UserQuery::setPublishedMin()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setQuery(string $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setQuery()\Zend_Gdata_Photos_UserQuery::setQuery()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setStartIndex(int $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setStartIndex()\Zend_Gdata_Photos_UserQuery::setStartIndex()

Parameters

Name	Type	Description
$value	int

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setTag(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

Name	Type	Description
$value	string	The tag to filter by, or null if no filter is to be applied.

setThumbsize(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

Name	Type	Description
$value	string	The thumbnail size to filter by, or null if no filter is to be applied.

setType(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

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Photos_UserQuery	Provides a fluent interface

setUpdatedMax(string $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setUpdatedMax()\Zend_Gdata_Photos_UserQuery::setUpdatedMax()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setUpdatedMin(string $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setUpdatedMin()\Zend_Gdata_Photos_UserQuery::setUpdatedMin()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setUser(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

Name	Type	Description
$value	string	The user to retrieve, or null for the default user.

Gdata/Photos/AlbumQuery.php

\Zend_Gdata_Photos_AlbumQueryjump to top

Properties

Methods

\Zend_Gdata_Photos_AlbumQuery
jump to top