API Documentation

Gdata/Spreadsheets/DocumentQuery.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Gdata  
subpackage
Spreadsheets  
version
$Id: DocumentQuery.php 23805 2011-03-16 00:55:40Z tjohns $  

\Zend_Gdata_Spreadsheets_DocumentQuery

Assists in constructing queries for Google Spreadsheets documents

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

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

Constants

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

Properties

Propertyprotectedstring  $_defaultFeedUri= 'self'

Default URL

Default valueselfDetails
Type
string
Propertyprotected  $_documentType= ''
Details
Type
Propertyprotected  $_projection= 'full'
Default valuefullDetails
Type
Propertyprotected  $_spreadsheetKey= 'null'
Default valuenullDetails
Type
Propertyprotected  $_visibility= 'private'
Default valueprivateDetails
Type
Propertyprotected  $_worksheetId= 'null'
Default valuenullDetails
Type

Methods

methodpublic__construct( ) : void

Constructs a new Zend_Gdata_Spreadsheets_DocumentQuery object.

methodpublic__get(  $name ) : void

Inherited from: \Zend_Gdata_Query::__get()
Parameters
Name Type Description
$name
methodpublic__set(  $name,  $val ) : void

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

methodpublicgetAlt( ) : string

Inherited from: \Zend_Gdata_Query::getAlt()
Returns
Type Description
string rss or atom
methodpublicgetAuthor( ) : string
Returns
Type Description
string author
methodpublicgetCategory( ) : void
methodpublicgetDocumentType( ) : string

Gets the document type for this query.

Returns
Type Description
string document type
methodpublicgetMaxResults( ) : int
Returns
Type Description
int maxResults
methodpublicgetParam( string $name ) : void
Parameters
Name Type Description
$name string
methodpublicgetProjection( ) : string

Gets the projection for this query.

Returns
Type Description
string projection
methodpublicgetPublishedMax( ) : string
Returns
Type Description
string publishedMax
methodpublicgetPublishedMin( ) : string
Returns
Type Description
string publishedMin
methodpublicgetQuery( ) : string
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
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
Returns
Type Description
string updatedMax
methodpublicgetUpdatedMin( ) : string
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
methodpublicsetAlt( string $value ) : \Zend_Gdata_Query

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
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetCategory( string $value ) : \Zend_Gdata_Query
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
Parameters
Name Type Description
$value int
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetParam( string $name, string $value ) : \Zend_Gdata_Query
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
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetPublishedMin( string $value ) : \Zend_Gdata_Query
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetQuery( string $value ) : \Zend_Gdata_Query
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
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
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetUpdatedMin( string $value ) : \Zend_Gdata_Query
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 DocBlox 0.13.3.