## Zend_Gdata_Gapps_NicknameQuery

Description

Assists in constructing queries for Google Apps nickname 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 Google Apps service class, Zend_Gdata_Gapps.

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

Located in /Gdata/Gapps/NicknameQuery.php (line 43)

    Zend_Gdata_Query
       |
       --Zend_Gdata_Gapps_Query
          |
          --Zend_Gdata_Gapps_NicknameQuery

Variable Summary
string $_nickname
Method Summary
Zend_Gdata_Gapps_NicknameQuery __construct ([string $domain = null], [string $nickname = null], [string $username = null], [string $startNickname = null])
string getNickname ()
string getQueryUrl ()
string getStartNickname ()
string getUsername ()
void setNickname (string $value)
void setStartNickname (string $value)
void setUsername (string $value)
Variables
string $_nickname = null (line 52)

If not null, indicates the name of the nickname entry which should be returned by this query.

- access: protected

#### Inherited Variables

Inherited from Zend_Gdata_Gapps_Query

> Zend_Gdata_Gapps_Query::$_domain

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 66)

Create a new instance.

- access: public

Zend_Gdata_Gapps_NicknameQuery __construct ([string $domain = null], [string $nickname = null], [string $username = null], [string $startNickname = null])

- string $domain: (optional) The Google Apps-hosted domain to use when constructing query URIs.
- string $nickname: (optional) Value for the nickname property.
- string $username: (optional) Value for the username property.
- string $startNickname: (optional) Value for the startNickname property.

Redefinition of:

Zend_Gdata_Gapps_Query::__construct()
  Create a new instance.

getNickname (line 96)

Get the nickname to query for. If no nickname is set, null will be returned.

- return: The nickname to filter search results by, or null if disabled.
- see: Zend_Gdata_Gapps_NicknameQuery::setNickname()
- access: public

string getNickname ()
getQueryUrl (line 174)

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

- return: A URL generated based on the state of this query.
- access: public

string getQueryUrl ()

Redefinition of:

Zend_Gdata_Query::getQueryUrl()

getStartNickname (line 159)

Get the first nickname which should be displayed when retrieving a list of nicknames.

- return: The first nickname to be returned, or null to disable.
- access: public

string getStartNickname ()
getUsername (line 127)

Get the username to query for. If no username is set, null will be returned.

- return: The username to filter search results by, or null if disabled.
- see: Zend_Gdata_Gapps_NicknameQuery::setUsername()
- access: public

string getUsername ()
setNickname (line 83)

Set the nickname to query for. When set, only users with a nickname matching this value will be returned in search results. Set to null to disable filtering by username.

- access: public

void setNickname (string $value)

- string $value: The nickname to filter search results by, or null to disable.

setStartNickname (line 143)

Set the first nickname which should be displayed when retrieving a list of nicknames.

- access: public

void setStartNickname (string $value)

- string $value: The first nickname to be returned, or null to disable.

setUsername (line 109)

Set the username to query for. When set, only users with a username matching this value will be returned in search results. Set to null to disable filtering by username.

- access: public

void setUsername (string $value)

- string $value: The username to filter search results by, or null to disable.

#### Inherited Methods

Inherited From Zend_Gdata_Gapps_Query

> Zend_Gdata_Gapps_Query::__construct()
> Zend_Gdata_Gapps_Query::getBaseUrl()
> Zend_Gdata_Gapps_Query::getDomain()
> Zend_Gdata_Gapps_Query::setDomain()

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:01 +0400 by phpDocumentor 1.4.2