Zend_Gdata_Gapps_GroupQuery Class Reference

Public Member Functions
	__construct ($domain=null, $groupId=null, $startGroupId=null)
	Create a new instance.
	setGroupId ($value)
	Set the group id to query for.
	getGroupId ()
	Get the group id to query for.
	setMember ($value)
	Set the member to query for.
	getMember ()
	Get the member email address to query for.
	setDirectOnly ($value)
	Sets the query parameter directOnly.
	getDirectOnly ()
	setStartGroupId ($value)
	Set the first group id which should be displayed when retrieving a list of groups.
	getStartGroupId ()
	Get the first group id which should be displayed when retrieving a list of groups.
	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
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,
			$startGroupId = 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	$startGroupName	(optional) Value for the startGroupName property.

Member Function Documentation

getDirectOnly

(

)

See Also

setDirectOnly

Returns

bool

getGroupId

(

)

Get the group id to query for.

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

Parameters

string

$value

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

getMember

(

)

Get the member email address to query for.

If no member is set, null will be returned.

See Also

setMember

Returns

string The member email address to filter search results by, or null if disabled.

getQueryUrl

(

)

Returns the query URL generated by this query instance.

Returns

string The query URL for this instance.

getStartGroupId

(

)

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

See Also

setStartGroupId

Returns

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

setDirectOnly

(

$value

)

Sets the query parameter directOnly.

Parameters

bool

$value

setGroupId

(

$value

)

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 Also

getGroupId

Parameters

string

$value

The group id to filter search results by, or null to disable.

setMember

(

$value

)

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.

Parameters

string

$value

The member email address to filter search results by, or null to disable.

setStartGroupId

(

$value

)

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

Parameters

string

$value

The first group id to be returned, or null to disable.

Member Data Documentation

$_groupId = null

protected