API Documentation

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

\Zend_Gdata_Spreadsheets_CellQuery

Package: Zend\Gdata\Spreadsheets

Assists in constructing queries for Google Spreadsheets cells

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_CELL_FEED_URI = 'https://spreadsheets.google.com/feeds/cells'

Properties

Propertyprotected  $_cellId= 'null'
Default valuenullDetails
Type
Propertyprotected  $_defaultFeedUri= 'self::SPREADSHEETS_CELL_FEED_URI'
Default valueself::SPREADSHEETS_CELL_FEED_URIDetails
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= ''default''
Default value'default'Details
Type

Methods

methodpublic__construct( string $url = null ) : void

Constructs a new Zend_Gdata_Spreadsheets_CellQuery object.

Parameters
Name Type Description
$url string

Base URL to use for queries

methodpublicgetCellId( ) : string

Gets the cell id for this query.

Returns
Type Description
string cell id
methodpublicgetMaxCol( ) : string

Gets the max-col attribute for this query.

Returns
Type Description
string max-col
methodpublicgetMaxRow( ) : string

Gets the max-row attribute for this query.

Returns
Type Description
string max-row
methodpublicgetMinCol( ) : string

Gets the min-col attribute for this query.

Returns
Type Description
string min-col
methodpublicgetMinRow( ) : string

Gets the min-row attribute for this query.

Returns
Type Description
string min-row
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
methodpublicgetRange( ) : string

Gets the range attribute for this query.

Returns
Type Description
string range
methodpublicgetReturnEmpty( ) : string

Gets the return-empty attribute for this query.

Returns
Type Description
string return-empty
methodpublicgetSpreadsheetKey( ) : string

Gets the spreadsheet key for this query.

Returns
Type Description
string spreadsheet key
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
methodpublicsetCellId( string $value ) : \Zend_Gdata_Spreadsheets_CellQuery

Sets the cell id for this query.

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

Sets the max-col attribute for this query.

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

Sets the max-row attribute for this query.

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

Sets the min-col attribute for this query.

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

Sets the min-row attribute for this query.

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

Sets the projection for this query.

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

Sets the range attribute for this query.

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

Sets the return-empty attribute for this query.

Parameters
Name Type Description
$value mixed

String or bool value for whether to return empty cells

Returns
Type Description
\Zend_Gdata_Spreadsheets_CellQuery 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
methodpublicsetVisibility(  $value ) : \Zend_Gdata_Spreadsheets_CellQuery

Sets the visibility for this query.

Parameters
Name Type Description
$value
Returns
Type Description
\Zend_Gdata_Spreadsheets_CellQuery 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.