## Zend_Gdata_Photos_UserQuery

Description

Assists in constructing queries for user 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/UserQuery.php (line 43)

    Zend_Gdata_Query
       |
       --Zend_Gdata_Photos_UserQuery

Direct descendents

Class | Description
--- | ---
Zend_Gdata_Photos_AlbumQuery | Assists in constructing album queries for various entries.

Variable Summary
string $_projection
string $_type
string $_user
Method Summary
Zend_Gdata_Photos_UserQuery __construct ()
string getAccess ()
string getImgMax ()
string getKind ()
string getProjection ()
string getQueryUrl ([ $incomingUri = null])
string getTag ()
string getThumbsize ()
string getType ()
string getUser ()
void setAccess (string $value)
void setImgMax (string $value)
void setKind (string $value)
Zend_Gdata_Photos_UserQuery setProjection (string $value)
void setTag (string $value)
void setThumbsize (string $value)
Zend_Gdata_Photos_UserQuery setType (string $value)
void setUser (string $value)
Variables
string $_projection = 'api' (line 52)

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

- access: protected

string $_type = 'feed' (line 60)

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

- access: protected

string $_user = Zend_Gdata_Photos::DEFAULT_USER (line 69)

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

- access: protected

#### Inherited Variables

Inherited from Zend_Gdata_Query

> Zend_Gdata_Query::$_category
> Zend_Gdata_Query::$_defaultFeedUri
> Zend_Gdata_Query::$_params
> Zend_Gdata_Query::$_url

Methods
Constructor __construct (line 74)

Create a new Query object with default values.

- access: public

Zend_Gdata_Photos_UserQuery __construct ()

Redefinition of:

Zend_Gdata_Query::__construct()
  Create Gdata_Query object

getAccess (line 181)

Get the visibility filter for entries returned.

- return: The visibility to filter by, or null for the default user.
- see: Zend_Gdata_Photos_UserQuery::setAccess()
- access: public

string getAccess ()
getImgMax (line 277)

Get the maximum image size filter for entries returned.

- return: The image size size to filter by, or null if no filter is to be applied.
- see: Zend_Gdata_Photos_UserQuery::setImgMax()
- access: public

string getImgMax ()
getKind (line 245)

Get the kind of entries to be returned.

- return: The kind to filter by, or null if no filter is to be applied.
- see: Zend_Gdata_Photos_UserQuery::setKind()
- access: public

string getKind ()
getProjection (line 98)

Gets the format of data in returned in Atom feeds.

- return: projection
- see: Zend_Gdata_Photos_UserQuery::setProjection()
- access: public

string getProjection ()
getQueryUrl (line 321)

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 = null])

- $incomingUri

Redefinition of:

Zend_Gdata_Query::getQueryUrl()

Redefined in descendants as:

- Zend_Gdata_Photos_AlbumQuery::getQueryUrl() : Returns the URL generated for this query, based on it's current parameters.
- Zend_Gdata_Photos_PhotoQuery::getQueryUrl() : Returns the URL generated for this query, based on it's current parameters.

getTag (line 213)

Get the tag filter for entries returned.

- return: The tag to filter by, or null if no filter is to be applied.
- see: Zend_Gdata_Photos_UserQuery::setTag()
- access: public

string getTag ()
getThumbsize (line 309)

Get the thumbnail size filter for entries returned.

- return: The thumbnail size to filter by, or null if no filter is to be applied.
- see: Zend_Gdata_Photos_UserQuery::setThumbsize()
- access: public

string getThumbsize ()
getType (line 122)

Gets the type of data in returned in queries.

- return: type
- see: Zend_Gdata_Photos_UserQuery::setType()
- access: public

string getType ()
getUser (line 150)

Get the user which is to be returned.

- return: The visibility to retrieve.
- see: Zend_Gdata_Photos_UserQuery::setUser()
- access: public

string getUser ()
setAccess (line 165)

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.

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

- access: public

void setAccess (string $value)

- string $value: The visibility to filter by, or null to use the default value.

setImgMax (line 261)

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.

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

- access: public

void setImgMax (string $value)

- string $value: The image size to filter by, or null if no filter is to be applied.

setKind (line 229)

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.

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

- access: public

void setKind (string $value)

- string $value: The kind to filter by, or null if no filter is to be applied.

setProjection (line 86)

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

- return: Provides a fluent interface
- access: public

Zend_Gdata_Photos_UserQuery setProjection (string $value)

- string $value

setTag (line 197)

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.

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

- access: public

void setTag (string $value)

- string $value: The tag to filter by, or null if no filter is to be applied.

setThumbsize (line 293)

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.

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

- access: public

void setThumbsize (string $value)

- string $value: The thumbnail size to filter by, or null if no filter is to be applied.

setType (line 110)

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

- return: Provides a fluent interface
- access: public

Zend_Gdata_Photos_UserQuery setType (string $value)

- string $value

setUser (line 135)

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.

- access: public

void setUser (string $value)

- string $value: The user to retrieve, or null for the default user.

#### Inherited Methods

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 Tue, 26 Oct 2010 20:09:20 +0400 by phpDocumentor 1.4.2