Zend/Gdata/Gapps/MemberQuery.php

Show:

inherited

Classes
- \Zend_Gdata_Gapps_MemberQuery

Table of Contents

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-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Gdata
Subpackage: Gapps
Version: $Id:$

\Zend_Gdata_Gapps_MemberQuery
jump to top

Package: Zend\Gdata\Gapps

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.

Parent(s): \Zend_Gdata_Gapps_Query < \Zend_Gdata_Query
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

string
                 $_groupId= 'null'

If not null, specifies the group id

Default valuenullDetails

Type: string

string
                 $_memberId= 'null'

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

Default valuenullDetails

Type: string

Methods

__construct(
          string $domain
              =
              null, string $groupId
              =
              null, string $memberId
              =
              null, string $startMemberId
              =
              null
          )
        
        :
          void

Create a new instance.

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.
$memberId	string	(optional) Value for the memberId property.
$startMemberId	string	(optional) Value for the startMemberId property.

getGroupId(
          
          )
        
        :
          string

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

Returns

Type	Description
string	The group id

getMemberId(
          
          )
        
        :
          \The

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

Returns

Type	Description
\The	member id

getQueryUrl(
          
          )
        
        :
          string

Returns the query URL generated by this query instance.

Returns

Type	Description
string	The query URL for this instance.

getStartMemberId(
          
          )
        
        :
          string

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

Returns

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

Details

See: \setStartUsername

setGroupId(
          string $value
          )
        
        :
          void

Set the group id to query for.

Parameters

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

Details

See: \getGroupId

setMemberId(
          string $value
          )
        
        :
          void

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.

Parameters

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

Details

See: \getMemberId

setStartMemberId(
          string $value
          )
        
        :
          void

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

Parameters

Name	Type	Description
$value	string	The first member id to be returned, or null to disable.

API Documentation

Zend/Gdata/Gapps/MemberQuery.php

\Zend_Gdata_Gapps_MemberQueryjump to top

Properties

Methods

\Zend_Gdata_Gapps_MemberQuery
jump to top