Gdata/Gapps/UserQuery.php
Show:
inherited
inherited
Classes
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Gdata
- Subpackage
- Gapps
- Version
- $Id$
\Zend_Gdata_Gapps_UserQuery
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
string $_username = nullIf not null, specifies the username of the user who should be
retrieved by this query.
Default value
nullDetails- Type
- string
Methods
__construct(string $domain = null, string $username = null, string $startUsername = null) : voidCreate a new instance.
Parameters
| Name | Type | Description |
|---|---|---|
| $domain | string | (optional) The Google Apps-hosted domain to use |
| $username | string | (optional) Value for the username |
| $startUsername | string | (optional) Value for the |
getQueryUrl() : stringReturns the query URL generated by this query instance.
Returns
| Type | Description |
|---|---|
| string | The query URL for this instance. |
getStartUsername() : stringGet the first username which should be displayed when retrieving a list of users.
getUsername() : voidGet the username to query for. If no username is set, null will be returned.
setStartUsername(string $value) : voidSet 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) : voidSet 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.