Zend Framework API Documentation
Back to top  

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.

category Zend
package Zend_Gdata
subpackage Gapps
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_Gdata_Gapps_Query

 Methods

Create a new instance.

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

Parameters

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

Create Gdata_Query object

__construct($url = null) 
Inherited

Parameters

$url

__get() 

__get($name) 
Inherited

Parameters

$name

__set() 

__set($name, $val) 
Inherited

Parameters

$name

$val

getAlt() 

getAlt() : string
Inherited

Returns

stringrss or atom

getAuthor() 

getAuthor() : string
Inherited

Returns

stringauthor

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.

getBaseUrl(string $domain = null) 
Inherited
see

Parameters

$domain

string

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

getCategory() 

getCategory() 
Inherited

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.

getDomain() : string
Inherited
see

Returns

stringThe domain to be used for this session, or null if not set.

getMaxResults() 

getMaxResults() : integer
Inherited

Returns

integermaxResults

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

getNickname() : string
see

Returns

stringThe nickname to filter search results by, or null if disabled.

getParam() 

getParam(string $name) 
Inherited

Parameters

$name

string

getPublishedMax() 

getPublishedMax() : string
Inherited

Returns

stringpublishedMax

getPublishedMin() 

getPublishedMin() : string
Inherited

Returns

stringpublishedMin

getQuery() 

getQuery() : string
Inherited

Returns

stringquery

getQueryString() 

getQueryString() : string
Inherited

Returns

stringquerystring

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

getQueryUrl() : string

Returns

stringA URL generated based on the state of this query.

getQueryUrl() 

getQueryUrl() : string
Inherited

Returns

stringurl

getStartIndex() 

getStartIndex() : integer
Inherited

Returns

integerstartIndex

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

getStartNickname() : string

Returns

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

getUpdatedMax() 

getUpdatedMax() : string
Inherited

Returns

stringupdatedMax

getUpdatedMin() 

getUpdatedMin() : string
Inherited

Returns

stringupdatedMin

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

getUsername() : string
see

Returns

stringThe username to filter search results by, or null if disabled.

resetParameters() 

resetParameters() 
Inherited

setAlt() 

setAlt(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setAuthor() 

setAuthor(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setCategory() 

setCategory(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

Set domain for this service instance. This should be a fully qualified domain, such as 'foo.example.com'.

setDomain(string $value) 
Inherited

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

$value

string

The domain to be used for this session.

setMaxResults() 

setMaxResults(integer $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

integer

Returns

\Zend_Gdata_QueryProvides a fluent interface

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.

setNickname(string $value) 

Parameters

$value

string

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

setParam() 

setParam(string $name, string $value) : \Zend_Gdata_Query
Inherited

Parameters

$name

string

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setPublishedMax() 

setPublishedMax(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setPublishedMin() 

setPublishedMin(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setQuery() 

setQuery(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setStartIndex() 

setStartIndex(integer $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

integer

Returns

\Zend_Gdata_QueryProvides a fluent interface

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

setStartNickname(string $value) 

Parameters

$value

string

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

setUpdatedMax() 

setUpdatedMax(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setUpdatedMin() 

setUpdatedMin(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

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.

setUsername(string $value) 

Parameters

$value

string

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

 Properties

 

Category for the query

$_category : string

Default

null
 

Default URL

$_defaultFeedUri : string

Default

null
 

The domain which is being administered via the Provisioning API.

$_domain : string

Default

null
 

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

$_nickname : string

Default

null
 

Query parameters.

$_params : array

Default

array()
 

Base URL TODO: Add setters and getters

$_url : string

Default

null