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

\Zend_Gdata_Spreadsheets_DocumentQuery

Package: Zend\Gdata\Spreadsheets
Assists in constructing queries for Google Spreadsheets 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

>VConstant  SPREADSHEETS_FEED_URI = 'https://spreadsheets.google.com/feeds'

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::SPREADSHEETS_FEED_URI
Default URL
Default valueself::SPREADSHEETS_FEED_URIDetails
Type
string
>VPropertyprotected$_documentType
Details
Type
n/a
>VPropertyprotectedarray $_params = array()
inherited
Query parameters.
Inherited from: \Zend_Gdata_Query::$$_params
Default valuearray()Details
Type
array
Inherited_from
\Zend_Gdata_Query::$$_params  
>VPropertyprotected$_projection = 'full'
Default value'full'Details
Type
n/a
>VPropertyprotected$_spreadsheetKey = null
Default valuenullDetails
Type
n/a
>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  
>VPropertyprotected$_visibility = 'private'
Default value'private'Details
Type
n/a
>VPropertyprotected$_worksheetId = null
Default valuenullDetails
Type
n/a

Methods

methodpublic__construct() : void

Constructs a new Zend_Gdata_Spreadsheets_DocumentQuery 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
methodprivateappendVisibilityProjection() : void

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()
methodpublicgetDocumentType() : string

Gets the document type for this query.

Returns
TypeDescription
stringdocument type
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

Gets the attribute query string for this query.

Returns
TypeDescription
stringquery string
methodpublicgetQueryUrl() : string

Gets the full query URL for this query.

Returns
TypeDescription
stringurl
methodpublicgetSpreadsheetKey() : string

Gets the spreadsheet key for this query.

Returns
TypeDescription
stringspreadsheet key
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
methodpublicgetWorksheetId() : string

Gets the worksheet id for this query.

Returns
TypeDescription
stringworksheet id
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
methodpublicsetDocumentType(string $value) : \Zend_Gdata_Spreadsheets_DocumentQuery

Sets the document type for this query.

Parameters
NameTypeDescription
$valuestring

spreadsheets or worksheets

Returns
TypeDescription
\Zend_Gdata_Spreadsheets_DocumentQueryProvides 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_Spreadsheets_DocumentQuery

Sets the projection for this query.

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_Spreadsheets_DocumentQueryProvides 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
methodpublicsetSpreadsheetKey(string $value) : \Zend_Gdata_Spreadsheets_CellQuery

Sets the spreadsheet key for this query.

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_Spreadsheets_CellQueryProvides 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_Spreadsheets_DocumentQuery

Sets the title attribute for this query.

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_Spreadsheets_DocumentQueryProvides a fluent interface
methodpublicsetTitleExact(string $value) : \Zend_Gdata_Spreadsheets_DocumentQuery

Sets the title-exact attribute for this query.

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_Spreadsheets_DocumentQueryProvides 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_Spreadsheets_DocumentQuery

Sets the visibility for this query.

Parameters
NameTypeDescription
$value
Returns
TypeDescription
\Zend_Gdata_Spreadsheets_DocumentQueryProvides a fluent interface
methodpublicsetWorksheetId(string $value) : \Zend_Gdata_Spreadsheets_CellQuery

Sets the worksheet id for this query.

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