API Documentation

Gdata/Gapps/GroupQuery.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
subpackage
Gapps
version
$Id:$
Classes
Zend_Gdata_Gapps_GroupQuery

Description

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.

Zend_Gdata_Gapps_GroupQuery
jump to top

Extends from
Zend_Gdata_Gapps_Query
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
subpackage
Gapps
Properties
$_groupId
Methods
__construct
setGroupId
getGroupId
setMember
getMember
setDirectOnly
getDirectOnly
setStartGroupId
getStartGroupId
getQueryUrl

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.

Properties

$_groupId
jump to class

string $_groupId = 'null'

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

Details

$_groupId
string
visibility
protected
default
null
final
false
static
false

Methods

__construct
jump to class

__construct( string $domain = null, string $groupId = null,  $startGroupId = null ) :

Create a new instance.

Arguments
$domain
string
(optional) The Google Apps-hosted domain to use when constructing query URIs.
$groupId
string
(optional) Value for the groupId property.
$startGroupId
Details
visibility
public
final
false
static
false

getDirectOnly
jump to class

getDirectOnly( ) : bool

Output
bool
Details
visibility
public
final
false
static
false
see
setDirectOnly

getGroupId
jump to class

getGroupId( ) :

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

Details
visibility
public
final
false
static
false

getMember
jump to class

getMember( ) : string

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

Output
string
The member email address to filter search results by, or null if disabled.
Details
visibility
public
final
false
static
false
see
setMember

getQueryUrl
jump to class

getQueryUrl( ) : string

Returns the query URL generated by this query instance.

Output
string
The query URL for this instance.
Details
visibility
public
final
false
static
false

getStartGroupId
jump to class

getStartGroupId( ) : string

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

Output
string
The first group id to be returned, or null if disabled.
Details
visibility
public
final
false
static
false
see
setStartGroupId

setDirectOnly
jump to class

setDirectOnly( bool $value ) :

Sets the query parameter directOnly

Arguments
$value
bool
Details
visibility
public
final
false
static
false

setGroupId
jump to class

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

Arguments
$value
string
The group id to filter search results by, or null to disable.
Details
visibility
public
final
false
static
false
see
getGroupId

setMember
jump to class

setMember( string $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.

Arguments
$value
string
The member email address to filter search results by, or null to disable.
Details
visibility
public
final
false
static
false

setStartGroupId
jump to class

setStartGroupId( string $value ) :

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

Arguments
$value
string
The first group id to be returned, or null to disable.
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.