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

\Zend_Gdata_Docs_Query

Package: Zend\Gdata\Docs
Assists in constructing queries for Google Document List documents

Queries are not defined for APP, but are provided by Gdata services as an extension.

Parent(s)
\Zend_Gdata_Query
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Link
http://code.google.com/apis/gdata/spreadsheets/  

Constants

>VConstantstring  DOCUMENTS_LIST_FEED_URI = 'https://docs.google.com/feeds/documents'
The base URL for retrieving a document list
string

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 = self::DOCUMENTS_LIST_FEED_URI
The generic base URL used by some inherited methods
Default valueself::DOCUMENTS_LIST_FEED_URIDetails
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 $_projection = 'full'
The projection determines how much detail should be given in the result of the query.

Full is the only valid projection for the documents list.

Default value'full'Details
Type
string
>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  
>VPropertyprotectedstring $_visibility = 'private'
The visibility to be used when querying for the feed.

A request for a feed with private visbility requires the user to be authenricated. Private is the only avilable visibility for the documents list.

Default value'private'Details
Type
string

Methods

methodpublic__construct() : void

Constructs a new instance of a Zend_Gdata_Docs_Query object.

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
methodpublicgetCategory() : void
inherited

Inherited from: \Zend_Gdata_Query::getCategory()
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
methodpublicgetProjection() : string

Gets the projection for this query.

Returns
TypeDescription
stringprojection
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

Gets the full query URL for this query.

Returns
TypeDescription
stringurl
methodpublicgetStartIndex() : int
inherited

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

Gets the title attribute for this query.

Returns
TypeDescription
stringtitle
methodpublicgetTitleExact() : string

Gets the title-exact attribute for this query.

Returns
TypeDescription
stringtitle-exact
methodpublicgetUpdatedMax() : string
inherited

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

Inherited from: \Zend_Gdata_Query::getUpdatedMin()
Returns
TypeDescription
stringupdatedMin
methodpublicgetVisibility() : string

Gets the visibility for this query.

Returns
TypeDescription
stringvisibility
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
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
methodpublicsetProjection(string $value) : \Zend_Gdata_Docs_Query

Sets the projection for this query.

Common values for projection include 'full'.

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_Docs_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
methodpublicsetTitle(string $value) : \Zend_Gdata_Docs_Query

Sets the title attribute for this query.

The title parameter is used to restrict the results to documents whose titles either contain or completely match the title.

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_Docs_QueryProvides a fluent interface
methodpublicsetTitleExact(boolean $value) : \Zend_Gdata_Docs_Query

Sets the title-exact attribute for this query.

If title-exact is set to true, the title query parameter will be used in an exact match. Only documents with a title identical to the title parameter will be returned.

Parameters
NameTypeDescription
$valueboolean

Use either true or false

Returns
TypeDescription
\Zend_Gdata_Docs_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
methodpublicsetVisibility( $value) : \Zend_Gdata_Docs_Query

Sets the visibility for this query.

Common values for visibility include 'private'.

Parameters
NameTypeDescription
$value
Returns
TypeDescription
\Zend_Gdata_Docs_QueryProvides a fluent interface
Documentation was generated by phpDocumentor 2.0.0a12.