## Zend_Gdata_Gapps_GroupQuery

Description

Assists in constructing queries for Google Apps group 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/GroupQuery.php (line 43)

    Zend_Gdata_Query
       |
       --Zend_Gdata_Gapps_Query
          |
          --Zend_Gdata_Gapps_GroupQuery

Variable Summary
string $_groupId
Method Summary
Zend_Gdata_Gapps_GroupQuery __construct ([string $domain = null], [string $groupId = null], [ $startGroupId = null], string $startGroupName)
bool getDirectOnly ()
void getGroupId (string $value)
string getMember ()
string getQueryUrl ()
string getStartGroupId ()
void setDirectOnly (bool $value)
void setGroupId (string $value)
void setMember (string $value)
void setStartGroupId (string $value)
Variables
string $_groupId = null (line 52)

If not null, specifies the group id of the group 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 63)

Create a new instance.

- access: public

Zend_Gdata_Gapps_GroupQuery __construct ([string $domain = null], [string $groupId = null], [ $startGroupId = null], string $startGroupName)

- string $domain: (optional) The Google Apps-hosted domain to use when constructing query URIs.
- string $groupId: (optional) Value for the groupId property.
- string $startGroupName: (optional) Value for the startGroupName property.
- $startGroupId

Redefinition of:

Zend_Gdata_Gapps_Query::__construct()
  Create a new instance.

getDirectOnly (line 155)

- see: Zend_Gdata_Gapps_GroupQuery::setDirectOnly()
- access: public

bool getDirectOnly ()
getGroupId (line 92)

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

- access: public

void getGroupId (string $value)

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

getMember (line 123)

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

- return: The member email address to filter search results by, or null if disabled.
- see: Zend_Gdata_Gapps_GroupQuery::setMember()
- access: public

string getMember ()
getQueryUrl (line 207)

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()

getStartGroupId (line 193)

Get the first group id which should be displayed when retrieving a list of groups.

- return: The first group id to be returned, or null if disabled.
- see: Zend_Gdata_Gapps_GroupQuery::setStartGroupId()
- access: public

string getStartGroupId ()
setDirectOnly (line 137)

Sets the query parameter directOnly

- access: public

void setDirectOnly (bool $value)

- bool $value

setGroupId (line 80)

Set the group id to query for. When set, only groups with a group id matching this value will be returned in search results. Set to null to disable filtering by group id.

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

void setGroupId (string $value)

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

setMember (line 105)

Set the member to query for. When set, only subscribers with an email address matching this value will be returned in search results.

Set to null to disable filtering by username.

- access: public

void setMember (string $value)

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

setStartGroupId (line 176)

Set the first group id which should be displayed when retrieving a list of groups.

- access: public

void setStartGroupId (string $value)

- string $value: The first group 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:08:48 +0400 by phpDocumentor 1.4.2