Assists in constructing queries for Google Document List documents

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

link http://code.google.com/apis/gdata/spreadsheets/
category Zend
package Zend_Gdata
subpackage Docs
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_Gdata_Query

 Methods

Constructs a new instance of a Zend_Gdata_Docs_Query object.

__construct() 
inherited_from \Zend_Gdata_Query::__construct()

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

getCategory()

getCategory() 
Inherited

getMaxResults()

getMaxResults() : integer
Inherited

Returns

integermaxResults

getParam()

getParam(string $name) 
Inherited

Parameters

$name

string

Gets the projection for this query.

getProjection() : string

Returns

stringprojection

getPublishedMax()

getPublishedMax() : string
Inherited

Returns

stringpublishedMax

getPublishedMin()

getPublishedMin() : string
Inherited

Returns

stringpublishedMin

getQuery()

getQuery() : string
Inherited

Returns

stringquery

getQueryString()

getQueryString() : string
Inherited

Returns

stringquerystring

Gets the full query URL for this query.

getQueryUrl() : string
inherited_from \Zend_Gdata_Query::getQueryUrl()

Returns

stringurl

getQueryUrl()

getQueryUrl() : string
Inherited

Returns

stringurl

getStartIndex()

getStartIndex() : integer
Inherited

Returns

integerstartIndex

Gets the title attribute for this query.

getTitle() : string

Returns

stringtitle

Gets the title-exact attribute for this query.

getTitleExact() : string

Returns

stringtitle-exact

getUpdatedMax()

getUpdatedMax() : string
Inherited

Returns

stringupdatedMax

getUpdatedMin()

getUpdatedMin() : string
Inherited

Returns

stringupdatedMin

Gets the visibility for this query.

getVisibility() : string

Returns

stringvisibility

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

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

Sets the projection for this query. Common values for projection include 'full'.

setProjection(string $value) : \Zend_Gdata_Docs_Query

Parameters

$value

string

Returns

\Zend_Gdata_Docs_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

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.

setTitle(string $value) : \Zend_Gdata_Docs_Query

Parameters

$value

string

Returns

\Zend_Gdata_Docs_QueryProvides a fluent interface

Sets the title-exact attribute for this query.

setTitleExact(boolean $value) : \Zend_Gdata_Docs_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

$value

boolean

Use either true or false

Returns

\Zend_Gdata_Docs_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

Sets the visibility for this query. Common values for visibility include 'private'.

setVisibility($value) : \Zend_Gdata_Docs_Query

Parameters

$value

Returns

\Zend_Gdata_Docs_QueryProvides a fluent interface

 Properties

 

Category for the query

$_category : string

Default

null
 

The generic base URL used by some inherited methods

$_defaultFeedUri : string

Default

self::DOCUMENTS_LIST_FEED_URI
inherited_from \Zend_Gdata_Query::_defaultFeedUri
 

Default URL

$_defaultFeedUri : string

Default

null
 

Query parameters.

$_params : array

Default

array()
 

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.

$_projection : string

Default

'full'
 

Base URL TODO: Add setters and getters

$_url : string

Default

null
 

The visibility to be used when querying for the feed. A request for a feed with private visbility requires the user to be authenricated.

$_visibility : string

Default

'private'

Private is the only avilable visibility for the documents list.

 Constants

 

The base URL for retrieving a document list

DOCUMENTS_LIST_FEED_URI = 'https://docs.google.com/feeds/documents' : string