## API Documentation

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

## \Zend_Gdata_Spreadsheets_ListQuery
jump to top

Assists in constructing queries for Google Spreadsheets lists

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/calendar/
package
  Zend_Gdata
subpackage
  Spreadsheets

### Constants

`SPREADSHEETS_LIST_FEED_URI = 'https://spreadsheets.google.com/feeds/list'`

### Properties

`string $_defaultFeedUri= 'self'`

Default URL

Default value `self` Details

Type
  string

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

Type

`$_rowId= 'null'`
Default value `null` 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( ) : void`

Constructs a new Zend_Gdata_Spreadsheets_ListQuery object.

`__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()
`getMaxResults( ) : int`

Inherited from: \Zend_Gdata_Query::getMaxResults()
Returns

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

`getOrderBy( ) : string`

Gets the orderby attribute for this query.

Returns

Type | Description
--- | ---
string | orderby

`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

`getReverse( ) : string`

Gets the reverse attribute for this query.

Returns

Type | Description
--- | ---
string | reverse

`getRowId( ) : string`

Gets the row id for the query.

Returns

Type | Description
--- | ---
string | row id

`getSpreadsheetKey( ) : string`

Gets the spreadsheet key for the query.

Returns

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

`getSpreadsheetQuery( ) : string`

Gets the spreadsheet key for this query.

Returns

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

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

`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

`setOrderBy( string $value ) : \Zend_Gdata_Spreadsheets_DocumentQuery`

Sets the orderby attribute for this query.

Parameters

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

Returns

Type | Description
--- | ---
\Zend_Gdata_Spreadsheets_DocumentQuery | 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_ListQuery`

Sets the projection for the query.

Parameters

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

Returns

Type | Description
--- | ---
\Zend_Gdata_Spreadsheets_ListQuery | 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

`setReverse( string $value ) : \Zend_Gdata_Spreadsheets_DocumentQuery`

Sets the reverse attribute for this query.

Parameters

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

Returns

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

`setRowId( string $value ) : \Zend_Gdata_Spreadsheets_CellQuery`

Sets the row id for the query.

Parameters

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

Returns

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

`setSpreadsheetKey( string $value ) : \Zend_Gdata_Spreadsheets_CellQuery`

Sets the spreadsheet key for the query.

Parameters

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

Returns

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

`setSpreadsheetQuery( string $value ) : \Zend_Gdata_Spreadsheets_DocumentQuery`

Sets the spreadsheet key for this query.

Parameters

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

Returns

Type | Description
--- | ---
\Zend_Gdata_Spreadsheets_DocumentQuery | 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( string $value ) : \Zend_Gdata_Spreadsheets_ListQuery`

Sets the visibility for this query.

Parameters

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

Returns

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

`setWorksheetId( string $value ) : \Zend_Gdata_Spreadsheets_CellQuery`

Sets the worksheet id for the 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.