API Documentation

Zend/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 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 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Gdata_Spreadsheets_DocumentQuery

Package: Zend\Gdata\Spreadsheets

Assists in constructing queries for Google Spreadsheets documents

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

Propertyprotected  $_defaultFeedUri= 'self::SPREADSHEETS_FEED_URI'
Default valueself::SPREADSHEETS_FEED_URIDetails
Type
Propertyprotected  $_documentType= ''
Details
Type
Propertyprotected  $_projection= ''full''
Default value'full'Details
Type
Propertyprotected  $_spreadsheetKey= 'null'
Default valuenullDetails
Type
Propertyprotected  $_visibility= ''private''
Default value'private'Details
Type
Propertyprotected  $_worksheetId= 'null'
Default valuenullDetails
Type

Methods

methodpublic__construct( ) : void

Constructs a new Zend_Gdata_Spreadsheets_DocumentQuery object.

methodprivateappendVisibilityProjection( ) : void

methodpublicgetDocumentType( ) : string

Gets the document type for this query.

Returns
Type Description
string document type
methodpublicgetProjection( ) : string

Gets the projection for this query.

Returns
Type Description
string projection
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
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
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
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
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
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
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
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.15.1.