Assists in constructing queries for comment/tag 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.

category Zend
package Zend_Gdata
subpackage Photos
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_Gdata_Photos_AlbumQuery

 Methods

Create Gdata_Query object

__construct($url = null
Inherited

Parameters

$url

__get()

__get($name) 
Inherited

Parameters

$name

__set()

__set($name, $val) 
Inherited

Parameters

$name

$val

Get the visibility filter for entries returned.

getAccess() : string
Inherited
see

Returns

stringThe visibility to filter by, or null for the default user.

Get the album ID which is to be returned.

getAlbumId() : string
Inherited
see

Returns

stringThe ID of the album to retrieve.

Get the album name which is to be returned.

getAlbumName() : string
Inherited
see

Returns

stringThe name of the album to retrieve.

getAlt()

getAlt() : string
Inherited

Returns

stringrss or atom

getAuthor()

getAuthor() : string
Inherited

Returns

stringauthor

getCategory()

getCategory() 
Inherited

Get the maximum image size filter for entries returned.

getImgMax() : string
Inherited
see

Returns

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

Get the kind of entries to be returned.

getKind() : string
Inherited
see

Returns

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

getMaxResults()

getMaxResults() : integer
Inherited

Returns

integermaxResults

getParam()

getParam(string $name) 
Inherited

Parameters

$name

string

Get the photo ID which is to be returned.

getPhotoId() : string
see

Returns

stringThe ID of the photo to retrieve.

Gets the format of data in returned in Atom feeds.

getProjection() : string
Inherited
see

Returns

stringprojection

getPublishedMax()

getPublishedMax() : string
Inherited

Returns

stringpublishedMax

getPublishedMin()

getPublishedMin() : string
Inherited

Returns

stringpublishedMin

getQuery()

getQuery() : string
Inherited

Returns

stringquery

getQueryString()

getQueryString() : string
Inherited

Returns

stringquerystring

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

getQueryUrl($incomingUri = '') : string
inherited_from \Zend_Gdata_Photos_AlbumQuery::getQueryUrl()

Parameters

$incomingUri

Exceptions

\Zend_Gdata_App_InvalidArgumentException

Returns

stringA URL generated based on the state of this query.

getQueryUrl()

getQueryUrl() : string
Inherited

Returns

stringurl

getStartIndex()

getStartIndex() : integer
Inherited

Returns

integerstartIndex

Get the tag filter for entries returned.

getTag() : string
Inherited
see

Returns

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

Get the thumbnail size filter for entries returned.

getThumbsize() : string
Inherited
see

Returns

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

Gets the type of data in returned in queries.

getType() : string
Inherited
see

Returns

stringtype

getUpdatedMax()

getUpdatedMax() : string
Inherited

Returns

stringupdatedMax

getUpdatedMin()

getUpdatedMin() : string
Inherited

Returns

stringupdatedMin

Get the user which is to be returned.

getUser() : string
Inherited
see

Returns

stringThe visibility to retrieve.

resetParameters()

resetParameters() 
Inherited

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

setAccess(string $value) 
Inherited

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

Parameters

$value

string

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

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.

setAlbumId(string $value) : \Zend_Gdata_Photos_AlbumQuery
Inherited

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

Parameters

$value

string

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

Returns

\Zend_Gdata_Photos_AlbumQueryThe query object.

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.

setAlbumName(string $value) : \Zend_Gdata_Photos_AlbumQuery
Inherited

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

Parameters

$value

string

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

Returns

\Zend_Gdata_Photos_AlbumQueryThe query object.

setAlt()

setAlt(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setAuthor()

setAuthor(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setCategory()

setCategory(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

Set the maximum image size for entries returned. Only entries which match this value will be returned. If null or unset, this filter will not be applied.

setImgMax(string $value) 
Inherited

Parameters

$value

string

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

Set the kind of entries that are returned. Only entries which match this value will be returned. If null or unset, this filter will not be applied.

setKind(string $value) 
Inherited

Parameters

$value

string

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

setMaxResults()

setMaxResults(integer $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

integer

Returns

\Zend_Gdata_QueryProvides a fluent interface

setParam()

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

Parameters

$name

string

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

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

setPhotoId(string $value) 

Parameters

$value

string

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

Set's the format of data returned in Atom feeds. Can be either 'api' or 'base'. Normally, 'api' will be desired. Default is 'api'.

setProjection(string $value) : \Zend_Gdata_Photos_UserQuery
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_Photos_UserQueryProvides a fluent interface

setPublishedMax()

setPublishedMax(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setPublishedMin()

setPublishedMin(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setQuery()

setQuery(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setStartIndex()

setStartIndex(integer $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

integer

Returns

\Zend_Gdata_QueryProvides a fluent interface

Set the tag for entries that are returned. Only entries which match this value will be returned. If null or unset, this filter will not be applied.

setTag(string $value) 
Inherited

Parameters

$value

string

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

Set the thumbnail size filter for entries returned. Only entries which match this value will be returned. If null or unset, this filter will not be applied.

setThumbsize(string $value) 
Inherited

Parameters

$value

string

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

Set's the type of data returned in queries. Can be either 'feed' or 'entry'. Normally, 'feed' will be desired. Default is 'feed'.

setType(string $value) : \Zend_Gdata_Photos_UserQuery
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_Photos_UserQueryProvides a fluent interface

setUpdatedMax()

setUpdatedMax(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setUpdatedMin()

setUpdatedMin(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

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

setUser(string $value) 
Inherited

Parameters

$value

string

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

 Properties

 

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

$_albumId : string

Default

null
 

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

$_albumName : string

Default

null
 

Category for the query

$_category : string

Default

null
 

Default URL

$_defaultFeedUri : string

Default

null
 

Query parameters.

$_params : array

Default

array()
 

The ID of the photo to query for.

$_photoId : string

Default

null
 

Indicates the format of data returned in Atom feeds. Can be either 'api' or 'base'. Default value is 'api'.

$_projection : string

Default

'api'
 

Indicates whether to request a feed or entry in queries. Default value is 'feed';

$_type : string

Default

'feed'
 

Base URL TODO: Add setters and getters

$_url : string

Default

null
 

A string which, if not null, indicates which user should be retrieved by this query. If null, the default user will be used instead.

$_user : string

Default

\Zend_Gdata_Photos::DEFAULT_USER