Gdata/Spreadsheets/DocumentQuery.php

Show: inherited
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 [email protected] 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

Constant  SPREADSHEETS_FEED_URI = 'https://spreadsheets.google.com/feeds'

Properties

Propertyprotectedstring $_category = null
inherited

Category for the query

Inherited from: \Zend_Gdata_Query::$$_category
Default valuenullDetails
Type
string
Inherited_from
\Zend_Gdata_Query::$$_category  
Propertyprotectedstring $_defaultFeedUri = self::SPREADSHEETS_FEED_URI

Default URL

Default valueself::SPREADSHEETS_FEED_URIDetails
Type
string
Propertyprotected$_documentType =
Details
Type
n/a
Propertyprotectedarray $_params = array()
inherited

Query parameters.

Inherited from: \Zend_Gdata_Query::$$_params
Default valuearray()Details
Type
array
Inherited_from
\Zend_Gdata_Query::$$_params  
Propertyprotected$_projection = 'full'
Default value'full'Details
Type
n/a
Propertyprotected$_spreadsheetKey = null
Default valuenullDetails
Type
n/a
Propertyprotectedstring $_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  
Propertyprotected$_visibility = 'private'
Default value'private'Details
Type
n/a
Propertyprotected$_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
Name Type Description
$name
methodpublic__set( $name,  $val) : void
inherited

Inherited from: \Zend_Gdata_Query::__set()
Parameters
Name Type Description
$name
$val
methodprivateappendVisibilityProjection() : void

methodpublicgetAlt() : string
inherited

Inherited from: \Zend_Gdata_Query::getAlt()
Returns
Type Description
string rss or atom
methodpublicgetAuthor() : string
inherited

Inherited from: \Zend_Gdata_Query::getAuthor()
Returns
Type Description
string author
methodpublicgetCategory() : void
inherited

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

Gets the document type for this query.

Returns
Type Description
string document type
methodpublicgetMaxResults() : int
inherited

Inherited from: \Zend_Gdata_Query::getMaxResults()
Returns
Type Description
int maxResults
methodpublicgetParam(string $name) : void
inherited

Inherited from: \Zend_Gdata_Query::getParam()
Parameters
Name Type Description
$name string
methodpublicgetProjection() : string

Gets the projection for this query.

Returns
Type Description
string projection
methodpublicgetPublishedMax() : string
inherited

Inherited from: \Zend_Gdata_Query::getPublishedMax()
Returns
Type Description
string publishedMax
methodpublicgetPublishedMin() : string
inherited

Inherited from: \Zend_Gdata_Query::getPublishedMin()
Returns
Type Description
string publishedMin
methodpublicgetQuery() : string
inherited

Inherited from: \Zend_Gdata_Query::getQuery()
Returns
Type Description
string query
methodpublicgetQueryString() : string

Gets the attribute query string for this query.

Returns
Type Description
string query string
methodpublicgetQueryUrl() : string

Gets the full query URL for this query.

Returns
Type Description
string url
methodpublicgetSpreadsheetKey() : string

Gets the spreadsheet key for this query.

Returns
Type Description
string spreadsheet key
methodpublicgetStartIndex() : int
inherited

Inherited from: \Zend_Gdata_Query::getStartIndex()
Returns
Type Description
int startIndex
methodpublicgetTitle() : string

Gets the title attribute for this query.

Returns
Type Description
string title
methodpublicgetTitleExact() : string

Gets the title-exact attribute for this query.

Returns
Type Description
string title-exact
methodpublicgetUpdatedMax() : string
inherited

Inherited from: \Zend_Gdata_Query::getUpdatedMax()
Returns
Type Description
string updatedMax
methodpublicgetUpdatedMin() : string
inherited

Inherited from: \Zend_Gdata_Query::getUpdatedMin()
Returns
Type Description
string updatedMin
methodpublicgetVisibility() : string

Gets the visibility for this query.

Returns
Type Description
string visibility
methodpublicgetWorksheetId() : string

Gets the worksheet id for this query.

Returns
Type Description
string worksheet id
methodpublicresetParameters() : void
inherited

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

Inherited from: \Zend_Gdata_Query::setAlt()
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetAuthor(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setAuthor()
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetCategory(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setCategory()
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetDocumentType(string $value) : \Zend_Gdata_Spreadsheets_DocumentQuery

Sets the document type for this query.

Parameters
Name Type Description
$value string

spreadsheets or worksheets

Returns
Type Description
\Zend_Gdata_Spreadsheets_DocumentQuery Provides a fluent interface
methodpublicsetMaxResults(int $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setMaxResults()
Parameters
Name Type Description
$value int
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetParam(string $name, string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setParam()
Parameters
Name Type Description
$name string
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetProjection(string $value) : \Zend_Gdata_Spreadsheets_DocumentQuery

Sets the projection for this query.

Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Spreadsheets_DocumentQuery Provides a fluent interface
methodpublicsetPublishedMax(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setPublishedMax()
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetPublishedMin(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setPublishedMin()
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetQuery(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setQuery()
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetSpreadsheetKey(string $value) : \Zend_Gdata_Spreadsheets_CellQuery

Sets the spreadsheet key for this query.

Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Spreadsheets_CellQuery Provides a fluent interface
methodpublicsetStartIndex(int $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setStartIndex()
Parameters
Name Type Description
$value int
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetTitle(string $value) : \Zend_Gdata_Spreadsheets_DocumentQuery

Sets the title attribute for this query.

Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Spreadsheets_DocumentQuery Provides a fluent interface
methodpublicsetTitleExact(string $value) : \Zend_Gdata_Spreadsheets_DocumentQuery

Sets the title-exact attribute for this query.

Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Spreadsheets_DocumentQuery Provides a fluent interface
methodpublicsetUpdatedMax(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setUpdatedMax()
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetUpdatedMin(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setUpdatedMin()
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetVisibility( $value) : \Zend_Gdata_Spreadsheets_DocumentQuery

Sets the visibility for this query.

Parameters
Name Type Description
$value
Returns
Type Description
\Zend_Gdata_Spreadsheets_DocumentQuery Provides a fluent interface
methodpublicsetWorksheetId(string $value) : \Zend_Gdata_Spreadsheets_CellQuery

Sets the worksheet id for this query.

Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Spreadsheets_CellQuery Provides a fluent interface
Documentation was generated by phpDocumentor 2.0.0a8.