API Documentation

Zend/Gdata/Gapps/NicknameQuery.php

Show: inherited
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: NicknameQuery.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Gdata_Gapps_NicknameQuery

Package: Zend\Gdata\Gapps

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.

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

Propertyprotectedstring  $_nickname= 'null'

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

Default valuenullDetails
Type
string

Methods

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

Create a new instance.

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.

methodpublicgetNickname( ) : 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  
methodpublicgetQueryUrl( ) : 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.
methodpublicgetStartNickname( ) : 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.
methodpublicgetUsername( ) : 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  
methodpublicsetNickname( 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.

methodpublicsetStartNickname( 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.

methodpublicsetUsername( 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.

Documentation was generated by DocBlox 0.15.1.