Gdata/Gapps/MemberQuery.php

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_MemberQuery

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_MemberQuery
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; $_memberId
Methods: __construct; setGroupId; getGroupId; setMemberId; getMemberId; setStartMemberId; getStartMemberId; getQueryUrl

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.

Properties

$_groupId
jump to class

string $_groupId = 'null'

If not null, specifies the group id

Details

$_groupId: string
visibility: protected
default: null
final: false
static: false

$_memberId
jump to class

string $_memberId = 'null'

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

Details

$_memberId: string
visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

__construct(
          string $domain
              =
              null, string $groupId
              =
              null, string $memberId
              =
              null, string $startMemberId
              =
              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.
$memberId: string
(optional) Value for the memberId property.
$startMemberId: string
(optional) Value for the startMemberId property.

Details

visibility: public
final: false
static: false

getGroupId
jump to class

getGroupId(
          
          )
        
        :
        string

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

Output

string: The group id

Details

visibility: public
final: false
static: false

getMemberId
jump to class

getMemberId(
          
          )
        
        :
        The

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

Output

The: member id

Details

visibility: public
final: false
static: false

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

getStartMemberId
jump to class

getStartMemberId(
          
          )
        
        :
        string

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

Output

string: The first username to be returned, or null if disabled.

Details

visibility: public
final: false
static: false
see: setStartUsername

setGroupId
jump to class

setGroupId(
          string $value
          )
        
        :

Set the group id to query for.

Arguments

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

Details

visibility: public
final: false
static: false
see: getGroupId

setMemberId
jump to class

setMemberId(
          string $value
          )
        
        :

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.

Arguments

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

Details

visibility: public
final: false
static: false
see: getMemberId

setStartMemberId
jump to class

setStartMemberId(
          string $value
          )
        
        :

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

Arguments

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

Details

visibility: public
final: false
static: false

API Documentation

Gdata/Gapps/MemberQuery.php

Description

Zend_Gdata_Gapps_MemberQueryjump to top

Description

Properties

$_groupIdjump to class

Details

$_memberIdjump to class

Details

Methods

__constructjump to class

Arguments

Details

getGroupIdjump to class

Output

Details

getMemberIdjump to class

Output

Details

getQueryUrljump to class

Output

Details

getStartMemberIdjump to class

Output

Details

setGroupIdjump to class

Arguments

Details

setMemberIdjump to class

Arguments

Details

setStartMemberIdjump to class

Arguments

Details

Zend_Gdata_Gapps_MemberQuery
jump to top

$_groupId
jump to class

$_memberId
jump to class

__construct
jump to class

getGroupId
jump to class

getMemberId
jump to class

getQueryUrl
jump to class

getStartMemberId
jump to class

setGroupId
jump to class

setMemberId
jump to class

setStartMemberId
jump to class