Gdata/Gapps/NicknameQuery.php
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: NicknameQuery.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Gdata_Gapps_NicknameQuery
Package: Zend\Gdata\GappsAssists in constructing queries for Google Apps nickname 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 $_nickname = null
If not null, indicates the name of the nickname entry which
should be returned by this query.
Default valuenull
Details- Type
- string
Methods



__construct(string $domain = null, string $nickname = null, string $username = null, string $startNickname = null) : void
ParametersName | Type | Description |
---|
$domain | string | (optional) The Google Apps-hosted domain to use
when constructing query URIs.
|
---|
$nickname | string | (optional) Value for the nickname
property.
|
---|
$username | string | (optional) Value for the username
property.
|
---|
$startNickname | string | (optional) Value for the
startNickname property.
|
---|



getBaseUrl(string $domain = null) : void
The current domain can be temporarily
overridden by providing a fully qualified domain as $domain.
ParametersName | Type | Description |
---|
$domain | string | (optional) A fully-qualified domain to use
instead of the default domain for this service instance.
|
---|
Details- See
- \setDomain



getNickname() : string
Get the nickname to query for.
If no nickname is set, null will be
returned.
ReturnsType | Description |
---|
string | The nickname to filter search results by, or null if
disabled. |
Details- See
- \setNickname



getQueryUrl() : string
Returns the URL generated for this query, based on it's current
parameters.
ReturnsType | Description |
---|
string | A URL generated based on the state of this query. |



getStartNickname() : string
Get the first nickname which should be displayed when retrieving
a list of nicknames.
ReturnsType | Description |
---|
string | The first nickname to be returned, or null to
disable. |



getUsername() : string
Get the username to query for.
If no username is set, null will be
returned.
ReturnsType | Description |
---|
string | The username to filter search results by, or null if
disabled. |
Details- See
- \setUsername



setDomain(string $value) : void
This should be a fully qualified
domain, such as 'foo.example.com'.
This value is used when calculating URLs for retrieving and posting
entries. If no value is specified, a URL will have to be manually
constructed prior to using any methods which interact with the Google
Apps provisioning service.
ParametersName | Type | Description |
---|
$value | string | The domain to be used for this session. |
---|



setNickname(string $value) : void
Set the nickname to query for.
When set, only users with a nickname
matching this value will be returned in search results. Set to
null to disable filtering by username.
ParametersName | Type | Description |
---|
$value | string | The nickname to filter search results by, or null
to disable. |
---|



setStartNickname(string $value) : void
Set the first nickname which should be displayed when retrieving
a list of nicknames.
ParametersName | Type | Description |
---|
$value | string | The first nickname 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.
ParametersName | Type | Description |
---|
$value | string | The username to filter search results by, or null
to disable. |
---|