Docs For Class Zend_Gdata_Spreadsheets

Description

Assists in constructing queries for Google Spreadsheets documents

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
link: http://code.google.com/apis/gdata/spreadsheets/
license: New BSD License

Located in /Gdata/Spreadsheets/DocumentQuery.php (line 45)

Zend_Gdata_Query
   |
   --Zend_Gdata_Spreadsheets_DocumentQuery

Class Constant Summary

SPREADSHEETS_FEED_URI = 'http://spreadsheets.google.com/feeds'

Variable Summary

mixed $_defaultFeedUri

mixed $_documentType

mixed $_projection

mixed $_spreadsheetKey

mixed $_visibility

mixed $_worksheetId

Method Summary

Zend_Gdata_Spreadsheets_DocumentQuery __construct ()

string getDocumentType ()

string getProjection ()

string getQueryString ()

string getQueryUrl ()

string getSpreadsheetKey ()

string getTitle ()

string getTitleExact ()

string getVisibility ()

string getWorksheetId ()

Zend_Gdata_Spreadsheets_DocumentQuery setDocumentType (string $value)

Zend_Gdata_Spreadsheets_DocumentQuery setProjection (string $value)

Zend_Gdata_Spreadsheets_CellQuery setSpreadsheetKey (string $value)

Zend_Gdata_Spreadsheets_DocumentQuery setTitle (string $value)

Zend_Gdata_Spreadsheets_DocumentQuery setTitleExact (string $value)

Zend_Gdata_Spreadsheets_DocumentQuery setVisibility ( $value)

Zend_Gdata_Spreadsheets_CellQuery setWorksheetId (string $value)

Variables

mixed $_defaultFeedUri = self::SPREADSHEETS_FEED_URI (line 50)

access: protected

Redefinition of:

Zend_Gdata_Query::$_defaultFeedUri: Default URL

mixed $_documentType (line 51)

access: protected

mixed $_projection = 'full' (line 53)

access: protected

mixed $_spreadsheetKey = null (line 54)

access: protected

mixed $_visibility = 'private' (line 52)

access: protected

mixed $_worksheetId = null (line 55)

access: protected

Inherited Variables

Inherited from Zend_Gdata_Query

Zend_Gdata_Query::$_category
Zend_Gdata_Query::$_params
Zend_Gdata_Query::$_url

Methods

Constructor __construct (line 60)

Constructs a new Zend_Gdata_Spreadsheets_DocumentQuery object.

access: public

Zend_Gdata_Spreadsheets_DocumentQuery __construct ()

Redefinition of:

Zend_Gdata_Query::__construct(): Create Gdata_Query object

getDocumentType (line 120)

Gets the document type for this query.

return: document type
access: public

string getDocumentType ()

getProjection (line 150)

Gets the projection for this query.

return: projection
access: public

string getProjection ()

getQueryString (line 283)

Gets the attribute query string for this query.

return: query string
access: public

string getQueryString ()

Redefinition of:

Zend_Gdata_Query::getQueryString()

getQueryUrl (line 246)

Gets the full query URL for this query.

return: url
access: public

string getQueryUrl ()

Redefinition of:

Zend_Gdata_Query::getQueryUrl()

getSpreadsheetKey (line 80)

Gets the spreadsheet key for this query.

return: spreadsheet key
access: public

string getSpreadsheetKey ()

getTitle (line 198)

Gets the title attribute for this query.

return: title
access: public

string getTitle ()

getTitleExact (line 211)

Gets the title-exact attribute for this query.

return: title-exact
access: public

string getTitleExact ()

getVisibility (line 159)

Gets the visibility for this query.

return: visibility
access: public

string getVisibility ()

getWorksheetId (line 100)

Gets the worksheet id for this query.

return: worksheet id
access: public

string getWorksheetId ()

setDocumentType (line 110)

Sets the document type for this query.

return: Provides a fluent interface
access: public

Zend_Gdata_Spreadsheets_DocumentQuery setDocumentType (string $value)

string $value: spreadsheets or worksheets

setProjection (line 130)

Sets the projection for this query.

return: Provides a fluent interface
access: public

Zend_Gdata_Spreadsheets_DocumentQuery setProjection (string $value)

string $value

setSpreadsheetKey (line 70)

Sets the spreadsheet key for this query.

return: Provides a fluent interface
access: public

Zend_Gdata_Spreadsheets_CellQuery setSpreadsheetKey (string $value)

string $value

setTitle (line 169)

Sets the title attribute for this query.

return: Provides a fluent interface
access: public

Zend_Gdata_Spreadsheets_DocumentQuery setTitle (string $value)

string $value

setTitleExact (line 184)

Sets the title-exact attribute for this query.

return: Provides a fluent interface
access: public

Zend_Gdata_Spreadsheets_DocumentQuery setTitleExact (string $value)

string $value

setVisibility (line 140)

Sets the visibility for this query.

return: Provides a fluent interface
access: public

Zend_Gdata_Spreadsheets_DocumentQuery setVisibility ( $value)

$value

setWorksheetId (line 90)

Sets the worksheet id for this query.

return: Provides a fluent interface
access: public

Zend_Gdata_Spreadsheets_CellQuery setWorksheetId (string $value)

string $value

Inherited Methods

Inherited From Zend_Gdata_Query

Zend_Gdata_Query::__construct()
Zend_Gdata_Query::getAlt()
Zend_Gdata_Query::getAuthor()
Zend_Gdata_Query::getCategory()
Zend_Gdata_Query::getMaxResults()
Zend_Gdata_Query::getParam()
Zend_Gdata_Query::getPublishedMax()
Zend_Gdata_Query::getPublishedMin()
Zend_Gdata_Query::getQuery()
Zend_Gdata_Query::getQueryString()
Zend_Gdata_Query::getQueryUrl()
Zend_Gdata_Query::getStartIndex()
Zend_Gdata_Query::getUpdatedMax()
Zend_Gdata_Query::getUpdatedMin()
Zend_Gdata_Query::resetParameters()
Zend_Gdata_Query::setAlt()
Zend_Gdata_Query::setAuthor()
Zend_Gdata_Query::setCategory()
Zend_Gdata_Query::setMaxResults()
Zend_Gdata_Query::setParam()
Zend_Gdata_Query::setPublishedMax()
Zend_Gdata_Query::setPublishedMin()
Zend_Gdata_Query::setQuery()
Zend_Gdata_Query::setStartIndex()
Zend_Gdata_Query::setUpdatedMax()
Zend_Gdata_Query::setUpdatedMin()
Zend_Gdata_Query::__get()
Zend_Gdata_Query::__set()

Class Constants

SPREADSHEETS_FEED_URI = 'http://spreadsheets.google.com/feeds' (line 48)