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

Public Member Functions

 __construct ($domain=null, $groupId=null, $memberId=null, $startMemberId=null)
 Create a new instance.
 
 setGroupId ($value)
 Set the group id to query for.
 
 getGroupId ()
 Get the group id to query for.
 
 setMemberId ($value)
 Set the member id to query for.
 
 getMemberId ()
 Get the member id to query for.
 
 setStartMemberId ($value)
 Set the first member id which should be displayed when retrieving a list of members.
 
 getStartMemberId ()
 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

 $_groupId = null
 
 $_memberId = 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,
  $groupId = null,
  $memberId = null,
  $startMemberId = null 
)

Create a new instance.

Parameters
string$domain(optional) The Google Apps-hosted domain to use when constructing query URIs.
string$groupId(optional) Value for the groupId property.
string$memberId(optional) Value for the memberId property.
string$startMemberId(optional) Value for the startMemberId property.

Member Function Documentation

getGroupId ( )

Get the group id to query for.

If no group id is set, null will be returned.

Parameters
string$valueThe group id to filter search results by, or null if disabled.
Returns
string The group id
getMemberId ( )

Get the member id to query for.

If no member id is set, null will be returned.

Parameters
string$valueThe member id to filter search results by, or null if disabled.
Returns
The member id
getQueryUrl ( )

Returns the query URL generated by this query instance.

Returns
string The query URL for this instance.
getStartMemberId ( )

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.
setGroupId (   $value)

Set the group id to query for.

See Also
getGroupId
Parameters
string$valueThe group id to filter search results by, or null to disable.
setMemberId (   $value)

Set the member id to query for.

When set, only users with a member id matching this value will be returned in search results. Set to null to disable filtering by member id.

See Also
getMemberId
Parameters
string$valueThe member id to filter search results by, or null to disable.
setStartMemberId (   $value)

Set the first member id which should be displayed when retrieving a list of members.

Parameters
string$valueThe first member id to be returned, or null to disable.

Member Data Documentation

$_groupId = null
protected
$_memberId = null
protected