Zend_Gdata_Gapps_NicknameQuery Class Reference

Public Member Functions
	__construct ($domain=null, $nickname=null, $username=null, $startNickname=null)
	Create a new instance.
	setNickname ($value)
	Set the nickname to query for.
	getNickname ()
	Get the nickname to query for.
	setUsername ($value)
	Set the username to query for.
	getUsername ()
	Get the username to query for.
	setStartNickname ($value)
	Set the first nickname which should be displayed when retrieving a list of nicknames.
	getStartNickname ()
	Get the first nickname which should be displayed when retrieving a list of nicknames.
	getQueryUrl ()
	Returns the URL generated for this query, based on it's current parameters.
Public Member Functions inherited from Zend_Gdata_Gapps_Query
	__construct ($domain=null)
	Create a new instance.
	setDomain ($value)
	Set domain for this service instance.
	getDomain ()
	Get domain for this service instance.
	getBaseUrl ($domain=null)
	Returns the base URL used to access the Google Apps service, based on the current domain.
Public Member Functions inherited from Zend_Gdata_Query
	__construct ($url=null)
	Create Gdata_Query object.
	getQueryString ()
	resetParameters ()
	getQueryUrl ()
	setParam ($name, $value)
	getParam ($name)
	setAlt ($value)
	setMaxResults ($value)
	setQuery ($value)
	setStartIndex ($value)
	setUpdatedMax ($value)
	setUpdatedMin ($value)
	setPublishedMax ($value)
	setPublishedMin ($value)
	setAuthor ($value)
	getAlt ()
	getMaxResults ()
	getQuery ()
	getStartIndex ()
	getUpdatedMax ()
	getUpdatedMin ()
	getPublishedMax ()
	getPublishedMin ()
	getAuthor ()
	setCategory ($value)
	getCategory ()
	__get ($name)
	__set ($name, $val)

Protected Attributes
	$_nickname = null
Protected Attributes inherited from Zend_Gdata_Gapps_Query
	$_domain = null
Protected Attributes inherited from Zend_Gdata_Query
	$_params = array()
	$_defaultFeedUri = null
	$_url = null
	$_category = null

Constructor & Destructor Documentation

__construct	(		$domain = null,
			$nickname = null,
			$username = null,
			$startNickname = null
	)

Create a new instance.

Parameters

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.

Member Function Documentation

getNickname

(

)

Get the nickname to query for.

If no nickname is set, null will be returned.

See Also

setNickname

Returns

string The nickname to filter search results by, or null if disabled.

getQueryUrl

(

)

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

Returns

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

getStartNickname

(

)

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

Returns

string The first nickname to be returned, or null to disable.

getUsername

(

)

Get the username to query for.

If no username is set, null will be returned.

See Also

setUsername

Returns

string The username to filter search results by, or null if disabled.

setNickname

(

$value

)

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.

Parameters

string

$value

The nickname to filter search results by, or null to disable.

setStartNickname

(

$value

)

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

Parameters

string

$value

The first nickname to be returned, or null to disable.

setUsername

(

$value

)

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.

Parameters

string

$value

The username to filter search results by, or null to disable.

Member Data Documentation

$_nickname = null

protected