Gdata/Gapps/NicknameQuery.php

Show: PublicProtectedPrivateinherited
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 24593 2012-01-05 20:35:02Z 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

>VPropertyprotectedstring $_category = null
inherited
Category for the query
Inherited from: \Zend_Gdata_Query::$$_category\Zend_Gdata_Gapps_Query::$$_category
Default valuenullDetails
Type
string
Inherited_from
\Zend_Gdata_Query::$$_category  
Inherited_from
\Zend_Gdata_Gapps_Query::$$_category  
>VPropertyprotectedstring $_defaultFeedUri = null
Default valuenullDetails
Type
string
Inherited_from
\Zend_Gdata_Query::$$_defaultFeedUri  
Inherited_from
\Zend_Gdata_Gapps_Query::$$_defaultFeedUri  
>VPropertyprotectedstring $_domain = null
inherited
The domain which is being administered via the Provisioning API.
Inherited from: \Zend_Gdata_Gapps_Query::$$_domain
Default valuenullDetails
Type
string
Inherited_from
\Zend_Gdata_Gapps_Query::$$_domain  
>VPropertyprotectedstring $_nickname = null
If not null, indicates the name of the nickname entry which should be returned by this query.
Default valuenullDetails
Type
string
>VPropertyprotectedarray $_params = array()
inherited
Query parameters.
Inherited from: \Zend_Gdata_Query::$$_params\Zend_Gdata_Gapps_Query::$$_params
Default valuearray()Details
Type
array
Inherited_from
\Zend_Gdata_Query::$$_params  
Inherited_from
\Zend_Gdata_Gapps_Query::$$_params  
>VPropertyprotectedstring $_url = null
inherited
Base URL TODO: Add setters and getters
Inherited from: \Zend_Gdata_Query::$$_url\Zend_Gdata_Gapps_Query::$$_url
Default valuenullDetails
Type
string
Inherited_from
\Zend_Gdata_Query::$$_url  
Inherited_from
\Zend_Gdata_Gapps_Query::$$_url  

Methods

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

Create a new instance.

Parameters
NameTypeDescription
$domainstring

(optional) The Google Apps-hosted domain to use when constructing query URIs.

$nicknamestring

(optional) Value for the nickname property.

$usernamestring

(optional) Value for the username property.

$startNicknamestring

(optional) Value for the startNickname property.

methodpublic__get( $name) : void
Parameters
NameTypeDescription
$name
methodpublic__set( $name,  $val) : void
Parameters
NameTypeDescription
$name
$val
methodpublicgetAlt() : string
Returns
TypeDescription
stringrss or atom
methodpublicgetAuthor() : string
Returns
TypeDescription
stringauthor
methodpublicgetBaseUrl(string $domain = null) : void
inherited

Returns the base URL used to access the Google Apps service, based on the current domain.

Inherited from: \Zend_Gdata_Gapps_Query::getBaseUrl()

The current domain can be temporarily overridden by providing a fully qualified domain as $domain.

Parameters
NameTypeDescription
$domainstring

(optional) A fully-qualified domain to use instead of the default domain for this service instance.

Details
See
\setDomain  
methodpublicgetDomain() : string
inherited

Get domain for this service instance.

Inherited from: \Zend_Gdata_Gapps_Query::getDomain()

This should be a fully qualified domain, such as 'foo.example.com'. If no domain is set, null will be returned.

Returns
TypeDescription
stringThe domain to be used for this session, or null if not set.
Details
See
\setDomain  
methodpublicgetMaxResults() : int
Returns
TypeDescription
intmaxResults
methodpublicgetNickname() : string

Get the nickname to query for.

If no nickname is set, null will be returned.

Returns
TypeDescription
stringThe nickname to filter search results by, or null if disabled.
Details
See
\setNickname  
methodpublicgetParam(string $name) : void
Parameters
NameTypeDescription
$namestring
methodpublicgetPublishedMax() : string
Returns
TypeDescription
stringpublishedMax
methodpublicgetPublishedMin() : string
Returns
TypeDescription
stringpublishedMin
methodpublicgetQuery() : string
Returns
TypeDescription
stringquery
methodpublicgetQueryString() : string
Returns
TypeDescription
stringquerystring
methodpublicgetQueryUrl() : string

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

Returns
TypeDescription
stringA URL generated based on the state of this query.
methodpublicgetStartIndex() : int
Returns
TypeDescription
intstartIndex
methodpublicgetStartNickname() : string

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

Returns
TypeDescription
stringThe first nickname to be returned, or null to disable.
methodpublicgetUpdatedMax() : string
Returns
TypeDescription
stringupdatedMax
methodpublicgetUpdatedMin() : string
Returns
TypeDescription
stringupdatedMin
methodpublicgetUsername() : string

Get the username to query for.

If no username is set, null will be returned.

Returns
TypeDescription
stringThe username to filter search results by, or null if disabled.
Details
See
\setUsername  
methodpublicsetAlt(string $value) : \Zend_Gdata_Query
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetAuthor(string $value) : \Zend_Gdata_Query
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetCategory(string $value) : \Zend_Gdata_Query
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetDomain(string $value) : void
inherited

Set domain for this service instance.

Inherited from: \Zend_Gdata_Gapps_Query::setDomain()

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.

Parameters
NameTypeDescription
$valuestring

The domain to be used for this session.

methodpublicsetMaxResults(int $value) : \Zend_Gdata_Query
Parameters
NameTypeDescription
$valueint
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
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
NameTypeDescription
$valuestring

The nickname to filter search results by, or null to disable.

methodpublicsetParam(string $name, string $value) : \Zend_Gdata_Query
Parameters
NameTypeDescription
$namestring
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetPublishedMax(string $value) : \Zend_Gdata_Query
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetPublishedMin(string $value) : \Zend_Gdata_Query
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetQuery(string $value) : \Zend_Gdata_Query
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetStartIndex(int $value) : \Zend_Gdata_Query
Parameters
NameTypeDescription
$valueint
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetStartNickname(string $value) : void

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

Parameters
NameTypeDescription
$valuestring

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

methodpublicsetUpdatedMax(string $value) : \Zend_Gdata_Query
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetUpdatedMin(string $value) : \Zend_Gdata_Query
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
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
NameTypeDescription
$valuestring

The username to filter search results by, or null to disable.

Documentation was generated by phpDocumentor 2.0.0a12.