Assists in constructing queries for Google Apps entries. This class provides common methods used by all other Google Apps query classes.

This class should never be instantiated directly. Instead, instantiate a class which inherits from this class.

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_Query

 Methods

Create a new instance.

__construct(string $domain = null
inherited_from \Zend_Gdata_Query::__construct()

Parameters

$domain

string

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

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
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
see

Returns

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

getMaxResults()

getMaxResults() : integer
Inherited

Returns

integermaxResults

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

getQueryUrl()

getQueryUrl() : string
Inherited

Returns

stringurl

getStartIndex()

getStartIndex() : integer
Inherited

Returns

integerstartIndex

getUpdatedMax()

getUpdatedMax() : string
Inherited

Returns

stringupdatedMax

getUpdatedMin()

getUpdatedMin() : string
Inherited

Returns

stringupdatedMin

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) 

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

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

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

 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
 

Query parameters.

$_params : array

Default

array()
 

Base URL TODO: Add setters and getters

$_url : string

Default

null