Zend_Gdata_Gapps_UserQuery Class Reference

Inheritance diagram for Zend_Gdata_Gapps_UserQuery:

Collaboration diagram for Zend_Gdata_Gapps_UserQuery:

Public Member Functions
	__construct ($domain=null, $username=null, $startUsername=null)
	setUsername ($value)
	getUsername ()
	setStartUsername ($value)
	getStartUsername ()
	getQueryUrl ()
Protected Attributes
	$_username = null

---

Detailed Description

Definition at line 43 of file UserQuery.php.

---

Constructor & Destructor Documentation

__construct	(	$	domain = null,
		$	username = null,
		$	startUsername = null
	)

Create a new instance.

Parameters:

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

Definition at line 64 of file UserQuery.php.

Here is the call graph for this function:

---

Member Function Documentation

getQueryUrl

(

)

Returns the query URL generated by this query instance.

Returns:

string The query URL for this instance.

Reimplemented from Zend_Gdata_Query.

Definition at line 136 of file UserQuery.php.

Here is the call graph for this function:

getStartUsername

(

)

Get the first username which should be displayed when retrieving a list of users.

See also:

setStartUsername

Returns:

string The first username to be returned, or null if disabled.

Definition at line 122 of file UserQuery.php.

getUsername

(

)

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

Parameters:

string

$value

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

Definition at line 93 of file UserQuery.php.

setStartUsername

(

$

value

)

Set the first username which should be displayed when retrieving a list of users.

Parameters:

string

$value

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

Definition at line 105 of file UserQuery.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.

See also:

getUsername

Parameters:

string

$value

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

Definition at line 81 of file UserQuery.php.

Here is the caller graph for this function:

---

Field Documentation

$_username = null [protected]

Definition at line 52 of file UserQuery.php.

---

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

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