Zend_Gdata_Gapps_NicknameQuery Class Reference

Inheritance diagram for Zend_Gdata_Gapps_NicknameQuery:

Collaboration diagram for Zend_Gdata_Gapps_NicknameQuery:

Public Member Functions
	__construct ($domain=null, $nickname=null, $username=null, $startNickname=null)
	setNickname ($value)
	getNickname ()
	setUsername ($value)
	getUsername ()
	setStartNickname ($value)
	getStartNickname ()
	getQueryUrl ()
Protected Attributes
	$_nickname = null

---

Detailed Description

Definition at line 43 of file NicknameQuery.php.

---

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.

Definition at line 66 of file NicknameQuery.php.

Here is the call graph for this function:

---

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.

Definition at line 96 of file NicknameQuery.php.

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.

Reimplemented from Zend_Gdata_Query.

Definition at line 174 of file NicknameQuery.php.

Here is the call graph for this function:

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.

Definition at line 159 of file NicknameQuery.php.

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.

Definition at line 127 of file NicknameQuery.php.

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.

Definition at line 83 of file NicknameQuery.php.

Here is the caller graph for this function:

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.

Definition at line 143 of file NicknameQuery.php.

Here is the caller graph for this function:

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.

Definition at line 109 of file NicknameQuery.php.

Here is the caller graph for this function:

---

Field Documentation

$_nickname = null [protected]

Definition at line 52 of file NicknameQuery.php.

---

The documentation for this class was generated from the following file:

• C:/xampp/htdocs/moodle/lib/zend/Zend/Gdata/Gapps/NicknameQuery.php