Zend Framework  1.12
Public Member Functions | Protected Attributes | List of all members
Zend_Gdata_Gapps_UserQuery Class Reference

Public Member Functions

 __construct ($domain=null, $username=null, $startUsername=null)
 Create a new instance.
 
 setUsername ($value)
 Set the username to query for.
 
 getUsername ()
 Get the username to query for.
 
 setStartUsername ($value)
 Set the first username which should be displayed when retrieving a list of users.
 
 getStartUsername ()
 Get the first username which should be displayed when retrieving a list of users.
 
 getQueryUrl ()
 Returns the query URL generated by this query instance.
 
- 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

 $_username = 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,
  $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.

Member Function Documentation

getQueryUrl ( )

Returns the query URL generated by this query instance.

Returns
string The query URL for this instance.
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.
getUsername ( )

Get the username to query for.

If no username is set, null will be returned.

Parameters
string$valueThe username to filter search results by, or null if disabled.
setStartUsername (   $value)

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

Parameters
string$valueThe first username 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.

See Also
getUsername
Parameters
string$valueThe username to filter search results by, or null to disable.

Member Data Documentation

$_username = null
protected