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-2011 Zend Technologies USA Inc.
(http://www.zend.com)
- license
- New
BSD License
- package
- Zend_Gdata
- subpackage
- Gapps
- version
- $Id: NicknameQuery.php 23775 2011-03-01 17:25:24Z ralph $
\Zend_Gdata_Gapps_NicknameQuery
Assists 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.
- Extends from
- \Zend_Gdata_Gapps_Query
- category
- Zend
- copyright
- Copyright (c) 2005-2011 Zend Technologies USA Inc.
(http://www.zend.com)
- license
- New
BSD License
- package
- Zend_Gdata
- subpackage
- Gapps
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
Parameters
Name |
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
Returns the base URL used to access the
Google Apps service, based on the current domain. The current domain can
be temporarily overridden by providing a fully qualified domain as
$domain.
Inherited from: \Zend_Gdata_Gapps_Query::getBaseUrl()
Parameters
Name |
Type |
Description |
$domain |
string |
(optional) A fully-qualified domain to use instead of the
default domain for this service instance.
|
Details
- see
- \setDomain



getDomain( ) : string
Get domain for this service instance.
This should be a fully qualified domain, such as 'foo.example.com'. If
no domain is set, null will be returned.
Inherited from: \Zend_Gdata_Gapps_Query::getDomain()
Returns
Type |
Description |
string |
The domain to be used for this session, or null if not set. |
Details
- see
- \setDomain



getNickname( ) : string
Get the nickname to query for. If no
nickname is set, null will be returned.
Returns
Type |
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.
Returns
Type |
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.
Returns
Type |
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.
Returns
Type |
Description |
string |
The username to filter search results by, or null if
disabled. |
Details
- see
- \setUsername



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.
Parameters
Name |
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.
Parameters
Name |
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.
Parameters
Name |
Type |
Description |
$value |
string |
The username to filter search results by, or null to
disable. |