## Zend_Gdata_Gapps_MemberQuery

Description

Assists in constructing queries for Google Apps member entries.

Instances of this class can be provided in many places where a URL is required.

For information on submitting queries to a server, see the Google Apps service class, Zend_Gdata_Gapps.

- copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license: New BSD License

Located in /Gdata/Gapps/MemberQuery.php (line 43)

    Zend_Gdata_Query
       |
       --Zend_Gdata_Gapps_Query
          |
          --Zend_Gdata_Gapps_MemberQuery

Variable Summary
string $_groupId
string $_memberId
Method Summary
Zend_Gdata_Gapps_MemberQuery __construct ([string $domain = null], [string $groupId = null], [string $memberId = null], [string $startMemberId = null])
string getGroupId (string $value)
The getMemberId (string $value)
string getQueryUrl ()
string getStartMemberId ()
void setGroupId (string $value)
void setMemberId (string $value)
void setStartMemberId (string $value)
Variables
string $_groupId = null (line 51)

If not null, specifies the group id

- access: protected

string $_memberId = null (line 59)

If not null, specifies the member id of the user who should be retrieved by this query.

- access: protected

#### Inherited Variables

Inherited from Zend_Gdata_Gapps_Query

> Zend_Gdata_Gapps_Query::$_domain

Inherited from Zend_Gdata_Query

> Zend_Gdata_Query::$_category
> Zend_Gdata_Query::$_defaultFeedUri
> Zend_Gdata_Query::$_params
> Zend_Gdata_Query::$_url

Methods
Constructor __construct (line 71)

Create a new instance.

- access: public

Zend_Gdata_Gapps_MemberQuery __construct ([string $domain = null], [string $groupId = null], [string $memberId = null], [string $startMemberId = null])

- 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.

Redefinition of:

Zend_Gdata_Gapps_Query::__construct()
  Create a new instance.

getGroupId (line 100)

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

- return: The group id
- access: public

string getGroupId (string $value)

- string $value: The group id to filter search results by, or null if disabled.

getMemberId (line 128)

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

- return: member id
- access: public

The getMemberId (string $value)

- string $value: The member id to filter search results by, or null if disabled.

getQueryUrl (line 171)

Returns the query URL generated by this query instance.

- return: The query URL for this instance.
- access: public

string getQueryUrl ()

Redefinition of:

Zend_Gdata_Query::getQueryUrl()

getStartMemberId (line 157)

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

- return: The first username to be returned, or null if disabled.
- see: setStartUsername
- access: public

string getStartMemberId ()
setGroupId (line 87)

Set the group id to query for.

- see: Zend_Gdata_Gapps_MemberQuery::getGroupId()
- access: public

void setGroupId (string $value)

- string $value: The group id to filter search results by, or null to disable.

setMemberId (line 115)

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: Zend_Gdata_Gapps_MemberQuery::getMemberId()
- access: public

void setMemberId (string $value)

- string $value: The member id to filter search results by, or null to disable.

setStartMemberId (line 140)

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

- access: public

void setStartMemberId (string $value)

- string $value: The first member id to be returned, or null to disable.

#### Inherited Methods

Inherited From Zend_Gdata_Gapps_Query

> Zend_Gdata_Gapps_Query::__construct()
> Zend_Gdata_Gapps_Query::getBaseUrl()
> Zend_Gdata_Gapps_Query::getDomain()
> Zend_Gdata_Gapps_Query::setDomain()

Inherited From Zend_Gdata_Query

> Zend_Gdata_Query::__construct()
> Zend_Gdata_Query::getAlt()
> Zend_Gdata_Query::getAuthor()
> Zend_Gdata_Query::getCategory()
> Zend_Gdata_Query::getMaxResults()
> Zend_Gdata_Query::getParam()
> Zend_Gdata_Query::getPublishedMax()
> Zend_Gdata_Query::getPublishedMin()
> Zend_Gdata_Query::getQuery()
> Zend_Gdata_Query::getQueryString()
> Zend_Gdata_Query::getQueryUrl()
> Zend_Gdata_Query::getStartIndex()
> Zend_Gdata_Query::getUpdatedMax()
> Zend_Gdata_Query::getUpdatedMin()
> Zend_Gdata_Query::resetParameters()
> Zend_Gdata_Query::setAlt()
> Zend_Gdata_Query::setAuthor()
> Zend_Gdata_Query::setCategory()
> Zend_Gdata_Query::setMaxResults()
> Zend_Gdata_Query::setParam()
> Zend_Gdata_Query::setPublishedMax()
> Zend_Gdata_Query::setPublishedMin()
> Zend_Gdata_Query::setQuery()
> Zend_Gdata_Query::setStartIndex()
> Zend_Gdata_Query::setUpdatedMax()
> Zend_Gdata_Query::setUpdatedMin()
> Zend_Gdata_Query::__get()
> Zend_Gdata_Query::__set()

Documentation generated on Tue, 26 Oct 2010 20:09:00 +0400 by phpDocumentor 1.4.2