## API Documentation

# Gdata/Spreadsheets/CellQuery.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: CellQuery.php 23805 2011-03-16 00:55:40Z tjohns $

## \Zend_Gdata_Spreadsheets_CellQuery
jump to top

Assists in constructing queries for Google Spreadsheets cells

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

`SPREADSHEETS_CELL_FEED_URI = 'https://spreadsheets.google.com/feeds/cells'`

### Properties

`$_cellId= 'null'`
Default value `null` Details

Type

`string $_defaultFeedUri= 'self'`

Default URL

Default value `self` Details

Type
  string

`$_projection= 'full'`
Default value `full` Details

Type

`$_spreadsheetKey= 'null'`
Default value `null` Details

Type

`$_visibility= 'private'`
Default value `private` Details

Type

`$_worksheetId= 'default'`
Default value `default` Details

Type

### Methods

`__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

`__get( $name ) : void`

Inherited from: \Zend_Gdata_Query::__get()
Parameters

Name | Type | Description
--- | --- | ---
$name |  |

`__set( $name, $val ) : void`

Inherited from: \Zend_Gdata_Query::__set()
Parameters

Name | Type | Description
--- | --- | ---
$name |  |
$val |  |

`getAlt( ) : string`

Inherited from: \Zend_Gdata_Query::getAlt()
Returns

Type | Description
--- | ---
string | rss or atom

`getAuthor( ) : string`

Inherited from: \Zend_Gdata_Query::getAuthor()
Returns

Type | Description
--- | ---
string | author

`getCategory( ) : void`

Inherited from: \Zend_Gdata_Query::getCategory()
`getCellId( ) : string`

Gets the cell id for this query.

Returns

Type | Description
--- | ---
string | cell id

`getMaxCol( ) : string`

Gets the max-col attribute for this query.

Returns

Type | Description
--- | ---
string | max-col

`getMaxResults( ) : int`

Inherited from: \Zend_Gdata_Query::getMaxResults()
Returns

Type | Description
--- | ---
int | maxResults

`getMaxRow( ) : string`

Gets the max-row attribute for this query.

Returns

Type | Description
--- | ---
string | max-row

`getMinCol( ) : string`

Gets the min-col attribute for this query.

Returns

Type | Description
--- | ---
string | min-col

`getMinRow( ) : string`

Gets the min-row attribute for this query.

Returns

Type | Description
--- | ---
string | min-row

`getParam( string $name ) : void`

Inherited from: \Zend_Gdata_Query::getParam()
Parameters

Name | Type | Description
--- | --- | ---
$name | string |

`getProjection( ) : string`

Gets the projection for this query.

Returns

Type | Description
--- | ---
string | projection

`getPublishedMax( ) : string`

Inherited from: \Zend_Gdata_Query::getPublishedMax()
Returns

Type | Description
--- | ---
string | publishedMax

`getPublishedMin( ) : string`

Inherited from: \Zend_Gdata_Query::getPublishedMin()
Returns

Type | Description
--- | ---
string | publishedMin

`getQuery( ) : string`

Inherited from: \Zend_Gdata_Query::getQuery()
Returns

Type | Description
--- | ---
string | query

`getQueryString( ) : string`

Gets the attribute query string for this query.

Returns

Type | Description
--- | ---
string | query string

`getQueryUrl( ) : string`

Gets the full query URL for this query.

Returns

Type | Description
--- | ---
string | url

`getRange( ) : string`

Gets the range attribute for this query.

Returns

Type | Description
--- | ---
string | range

`getReturnEmpty( ) : string`

Gets the return-empty attribute for this query.

Returns

Type | Description
--- | ---
string | return-empty

`getSpreadsheetKey( ) : string`

Gets the spreadsheet key for this query.

Returns

Type | Description
--- | ---
string | spreadsheet key

`getStartIndex( ) : int`

Inherited from: \Zend_Gdata_Query::getStartIndex()
Returns

Type | Description
--- | ---
int | startIndex

`getUpdatedMax( ) : string`

Inherited from: \Zend_Gdata_Query::getUpdatedMax()
Returns

Type | Description
--- | ---
string | updatedMax

`getUpdatedMin( ) : string`

Inherited from: \Zend_Gdata_Query::getUpdatedMin()
Returns

Type | Description
--- | ---
string | updatedMin

`getVisibility( ) : string`

Gets the visibility for this query.

Returns

Type | Description
--- | ---
string | visibility

`getWorksheetId( ) : string`

Gets the worksheet id for this query.

Returns

Type | Description
--- | ---
string | worksheet id

`resetParameters( ) : void`

Inherited from: \Zend_Gdata_Query::resetParameters()
`setAlt( 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

`setAuthor( string $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setAuthor()
Parameters

Name | Type | Description
--- | --- | ---
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setCategory( string $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setCategory()
Parameters

Name | Type | Description
--- | --- | ---
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setCellId( 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

`setMaxCol( 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

`setMaxResults( int $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setMaxResults()
Parameters

Name | Type | Description
--- | --- | ---
$value | int |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setMaxRow( 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

`setMinCol( 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

`setMinRow( 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

`setParam( string $name, string $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setParam()
Parameters

Name | Type | Description
--- | --- | ---
$name | string |
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setProjection( 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

`setPublishedMax( string $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setPublishedMax()
Parameters

Name | Type | Description
--- | --- | ---
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setPublishedMin( string $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setPublishedMin()
Parameters

Name | Type | Description
--- | --- | ---
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setQuery( string $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setQuery()
Parameters

Name | Type | Description
--- | --- | ---
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setRange( 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

`setReturnEmpty( 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

`setSpreadsheetKey( 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

`setStartIndex( int $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setStartIndex()
Parameters

Name | Type | Description
--- | --- | ---
$value | int |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setUpdatedMax( string $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setUpdatedMax()
Parameters

Name | Type | Description
--- | --- | ---
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setUpdatedMin( string $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setUpdatedMin()
Parameters

Name | Type | Description
--- | --- | ---
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setVisibility( $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

`setWorksheetId( 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.