Gdata/Gapps/Query.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: Query.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Gdata_Gapps_Query

Package: Zend\Gdata\Gapps
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.

Parent(s)
\Zend_Gdata_Query
Children
\Zend_Gdata_Gapps_OwnerQuery
\Zend_Gdata_Gapps_MemberQuery
\Zend_Gdata_Gapps_EmailListQuery
\Zend_Gdata_Gapps_UserQuery
\Zend_Gdata_Gapps_NicknameQuery
\Zend_Gdata_Gapps_EmailListRecipientQuery
\Zend_Gdata_Gapps_GroupQuery
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
Default valuenullDetails
Type
string
Inherited_from
\Zend_Gdata_Query::$$_category  
>VPropertyprotectedstring $_defaultFeedUri = null
inherited
Default URL
Inherited from: \Zend_Gdata_Query::$$_defaultFeedUri
Default valuenullDetails
Type
string
Inherited_from
\Zend_Gdata_Query::$$_defaultFeedUri  
>VPropertyprotectedstring $_domain = null
The domain which is being administered via the Provisioning API.
Default valuenullDetails
Type
string
>VPropertyprotectedarray $_params = array()
inherited
Query parameters.
Inherited from: \Zend_Gdata_Query::$$_params
Default valuearray()Details
Type
array
Inherited_from
\Zend_Gdata_Query::$$_params  
>VPropertyprotectedstring $_url = null
inherited
Base URL TODO: Add setters and getters
Inherited from: \Zend_Gdata_Query::$$_url
Default valuenullDetails
Type
string
Inherited_from
\Zend_Gdata_Query::$$_url  

Methods

methodpublic__construct(string $domain = null) : void

Create a new instance.

Parameters
NameTypeDescription
$domainstring

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

methodpublic__get( $name) : void
inherited

Inherited from: \Zend_Gdata_Query::__get()
Parameters
NameTypeDescription
$name
methodpublic__set( $name,  $val) : void
inherited

Inherited from: \Zend_Gdata_Query::__set()
Parameters
NameTypeDescription
$name
$val
methodpublicgetAlt() : string
inherited

Inherited from: \Zend_Gdata_Query::getAlt()
Returns
TypeDescription
stringrss or atom
methodpublicgetAuthor() : string
inherited

Inherited from: \Zend_Gdata_Query::getAuthor()
Returns
TypeDescription
stringauthor
methodpublicgetBaseUrl(string $domain = null) : void

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.

Parameters
NameTypeDescription
$domainstring

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

Details
See
\setDomain  
methodpublicgetCategory() : void
inherited

Inherited from: \Zend_Gdata_Query::getCategory()
methodpublicgetDomain() : string

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.

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

Inherited from: \Zend_Gdata_Query::getMaxResults()
Returns
TypeDescription
intmaxResults
methodpublicgetParam(string $name) : void
inherited

Inherited from: \Zend_Gdata_Query::getParam()
Parameters
NameTypeDescription
$namestring
methodpublicgetPublishedMax() : string
inherited

Inherited from: \Zend_Gdata_Query::getPublishedMax()
Returns
TypeDescription
stringpublishedMax
methodpublicgetPublishedMin() : string
inherited

Inherited from: \Zend_Gdata_Query::getPublishedMin()
Returns
TypeDescription
stringpublishedMin
methodpublicgetQuery() : string
inherited

Inherited from: \Zend_Gdata_Query::getQuery()
Returns
TypeDescription
stringquery
methodpublicgetQueryString() : string
inherited

Inherited from: \Zend_Gdata_Query::getQueryString()
Returns
TypeDescription
stringquerystring
methodpublicgetQueryUrl() : string
inherited

Inherited from: \Zend_Gdata_Query::getQueryUrl()
Returns
TypeDescription
stringurl
methodpublicgetStartIndex() : int
inherited

Inherited from: \Zend_Gdata_Query::getStartIndex()
Returns
TypeDescription
intstartIndex
methodpublicgetUpdatedMax() : string
inherited

Inherited from: \Zend_Gdata_Query::getUpdatedMax()
Returns
TypeDescription
stringupdatedMax
methodpublicgetUpdatedMin() : string
inherited

Inherited from: \Zend_Gdata_Query::getUpdatedMin()
Returns
TypeDescription
stringupdatedMin
methodpublicresetParameters() : void
inherited

Inherited from: \Zend_Gdata_Query::resetParameters()
methodpublicsetAlt(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setAlt()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetAuthor(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setAuthor()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetCategory(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setCategory()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetDomain(string $value) : void

Set domain for this service instance.

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
inherited

Inherited from: \Zend_Gdata_Query::setMaxResults()
Parameters
NameTypeDescription
$valueint
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetParam(string $name, string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setParam()
Parameters
NameTypeDescription
$namestring
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetPublishedMax(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setPublishedMax()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetPublishedMin(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setPublishedMin()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetQuery(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setQuery()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetStartIndex(int $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setStartIndex()
Parameters
NameTypeDescription
$valueint
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetUpdatedMax(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setUpdatedMax()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetUpdatedMin(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setUpdatedMin()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
Documentation was generated by phpDocumentor 2.0.0a12.