Zend/Gdata/Gapps/UserQuery.php

Show:

inherited

Classes
- \Zend_Gdata_Gapps_UserQuery

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: UserQuery.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Gdata_Gapps_UserQuery
jump to top

Package: Zend\Gdata\Gapps

Assists in constructing queries for Google Apps user 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
                 $_username= 'null'

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

Default valuenullDetails

Type: string

Methods

__construct(
          string $domain
              =
              null, string $username
              =
              null, string $startUsername
              =
              null
          )
        
        :
          void

Create a new instance.

Parameters

Name	Type	Description
$domain	string	(optional) The Google Apps-hosted domain to use when constructing query URIs.
$username	string	(optional) Value for the username property.
$startUsername	string	(optional) Value for the startUsername property.

getQueryUrl(
          
          )
        
        :
          string

Returns the query URL generated by this query instance.

Returns

Type	Description
string	The query URL for this instance.

getStartUsername(
          
          )
        
        :
          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

getUsername(
          
          )
        
        :
          void

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

setStartUsername(
          string $value
          )
        
        :
          void

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

Parameters

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

setUsername(
          string $value
          )
        
        :
          void

Set the username to query for. When set, only users with a username matching this value will be returned in search results. Set to null to disable filtering by username.

Parameters

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

Details

See: \getUsername

API Documentation

Zend/Gdata/Gapps/UserQuery.php

\Zend_Gdata_Gapps_UserQueryjump to top

Properties

Methods

\Zend_Gdata_Gapps_UserQuery
jump to top