Gdata/Gapps/NicknameQuery.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Gdata
subpackage: Gapps
version: $Id: NicknameQuery.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Gdata_Gapps_NicknameQuery

Description

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.

Zend_Gdata_Gapps_NicknameQuery
jump to top

Extends from: Zend_Gdata_Gapps_Query
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Gdata
subpackage: Gapps
Properties: $_nickname
Methods: __construct; setNickname; getNickname; setUsername; getUsername; setStartNickname; getStartNickname; getQueryUrl

Description

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.

Properties

$_nickname
jump to class

string $_nickname = 'null'

If not null, indicates the name of the nickname entry which should be returned by this query.

Details

$_nickname: string
visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

__construct(
          string $domain
              =
              null, string $nickname
              =
              null, string $username
              =
              null, string $startNickname
              =
              null
          )
        
        :

Create a new instance.

Arguments

$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.

Details

visibility: public
final: false
static: false

getNickname
jump to class

getNickname(
          
          )
        
        :
        string

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

Output

string: The nickname to filter search results by, or null if disabled.

Details

visibility: public
final: false
static: false
see: setNickname

getQueryUrl
jump to class

getQueryUrl(
          
          )
        
        :
        string

Returns the URL generated for this query, based on it's current parameters.

Output

string: A URL generated based on the state of this query.

Details

visibility: public
final: false
static: false

getStartNickname
jump to class

getStartNickname(
          
          )
        
        :
        string

Get the first nickname which should be displayed when retrieving a list of nicknames.

Output

string: The first nickname to be returned, or null to disable.

Details

visibility: public
final: false
static: false

getUsername
jump to class

getUsername(
          
          )
        
        :
        string

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

Output

string: The username to filter search results by, or null if disabled.

Details

visibility: public
final: false
static: false
see: setUsername

setNickname
jump to class

setNickname(
          string $value
          )
        
        :

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.

Arguments

$value: string
The nickname to filter search results by, or null to disable.

Details

visibility: public
final: false
static: false

setStartNickname
jump to class

setStartNickname(
          string $value
          )
        
        :

Set the first nickname which should be displayed when retrieving a list of nicknames.

Arguments

$value: string
The first nickname to be returned, or null to disable.

Details

visibility: public
final: false
static: false

setUsername
jump to class

setUsername(
          string $value
          )
        
        :

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.

Arguments

$value: string
The username to filter search results by, or null to disable.

Details

visibility: public
final: false
static: false

API Documentation

Gdata/Gapps/NicknameQuery.php

Description

Zend_Gdata_Gapps_NicknameQueryjump to top

Description

Properties

$_nicknamejump to class

Details

Methods

__constructjump to class

Arguments

Details

getNicknamejump to class

Output

Details

getQueryUrljump to class

Output

Details

getStartNicknamejump to class

Output

Details

getUsernamejump to class

Output

Details

setNicknamejump to class

Arguments

Details

setStartNicknamejump to class

Arguments

Details

setUsernamejump to class

Arguments

Details

Zend_Gdata_Gapps_NicknameQuery
jump to top

$_nickname
jump to class

__construct
jump to class

getNickname
jump to class

getQueryUrl
jump to class

getStartNickname
jump to class

getUsername
jump to class

setNickname
jump to class

setStartNickname
jump to class

setUsername
jump to class