Gdata/Gapps/GroupQuery.php
Zend Framework
LICENSE
This source file is subject to the new BSD license that is
bundled with this package in the file LICENSE.txt. It is also available
through the world-wide-web at this URL:
http://framework.zend.com/license/new-bsd If you did not receive a copy
of the license and are unable to obtain it through the world-wide-web,
please send an email to license@zend.com so we can send you a copy
immediately.
- category
- Zend
- copyright
- Copyright (c) 2005-2011 Zend Technologies USA Inc.
(http://www.zend.com)
- license
- New
BSD License
- package
- Zend_Gdata
- subpackage
- Gapps
- version
- $Id:$
\Zend_Gdata_Gapps_GroupQuery
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.
- Extends from
- \Zend_Gdata_Gapps_Query
- category
- Zend
- copyright
- Copyright (c) 2005-2011 Zend Technologies USA Inc.
(http://www.zend.com)
- license
- New
BSD License
- package
- Zend_Gdata
- subpackage
- Gapps
Properties



string $_groupId=
'null'
If not null, specifies the group id of
the group who should be retrieved by this query.
Default valuenull
Details
- Type
- string
Methods



__construct( string $domain = null, string $groupId =
null, $startGroupId = null ) : void
Parameters
Name |
Type |
Description |
$domain |
string |
(optional) The Google Apps-hosted domain to use when
constructing query URIs.
|
$groupId |
string |
(optional) Value for the groupId property.
|
$startGroupId |
|
|



getBaseUrl( string $domain = null ) : void
Returns the base URL used to access the
Google Apps service, based on the current domain. The current domain can
be temporarily overridden by providing a fully qualified domain as
$domain.
Inherited from: \Zend_Gdata_Gapps_Query::getBaseUrl()
Parameters
Name |
Type |
Description |
$domain |
string |
(optional) A fully-qualified domain to use instead of the
default domain for this service instance.
|
Details
- see
- \setDomain



getDomain( ) : string
Get domain for this service instance.
This should be a fully qualified domain, such as 'foo.example.com'. If
no domain is set, null will be returned.
Inherited from: \Zend_Gdata_Gapps_Query::getDomain()
Returns
Type |
Description |
string |
The domain to be used for this session, or null if not set. |
Details
- see
- \setDomain



getMember( ) : string
Get the member email address to query
for. If no member is set, null will be returned.
Returns
Type |
Description |
string |
The member email address to filter search results by, or null
if disabled. |
Details
- see
- \setMember



getQueryUrl( ) : string
Returns the query URL generated by this
query instance.
Returns
Type |
Description |
string |
The query URL for this instance. |



getStartGroupId( ) : string
Get the first group id which should be
displayed when retrieving a list of groups.
Returns
Type |
Description |
string |
The first group id to be returned, or null if disabled. |
Details
- see
- \setStartGroupId



setDirectOnly( bool $value ) : void
Sets the query parameter directOnly
Parameters
Name |
Type |
Description |
$value |
bool |
|



setGroupId( string $value ) : void
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.
Parameters
Name |
Type |
Description |
$value |
string |
The group id to filter search results by, or null to
disable. |
Details
- see
- \getGroupId



setMember( string $value ) : void
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
Name |
Type |
Description |
$value |
string |
The member email address to filter search results
by, or null to disable. |



setStartGroupId( string $value ) : void
Set the first group id which should be
displayed when retrieving a list of groups.
Parameters
Name |
Type |
Description |
$value |
string |
The first group id to be returned, or null to
disable. |