Docs For Class Zend_Gdata

Description

Gdata Spreadsheets

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

Located in /Gdata/Spreadsheets.php (line 95)

Zend_Gdata_App
   |
   --Zend_Gdata
      |
      --Zend_Gdata_Spreadsheets

Class Constant Summary

AUTH_SERVICE_NAME = 'wise'

CELL_FEED_LINK_URI = 'http://schemas.google.com/spreadsheets/2006#cellsfeed'

LIST_FEED_LINK_URI = 'http://schemas.google.com/spreadsheets/2006#listfeed'

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

SPREADSHEETS_POST_URI = 'http://spreadsheets.google.com/feeds/spreadsheets/private/full'

WORKSHEETS_FEED_LINK_URI = 'http://schemas.google.com/spreadsheets/2006#worksheetsfeed'

Variable Summary

static array $namespaces

Method Summary

Zend_Gdata_Spreadsheets __construct ([Zend_Http_Client $client = null], [string $applicationId = 'MyCompany-MyApp-1.0'])

void deleteRow (ListEntry $entry)

CellEntry getCellEntry (string $location)

CellFeed getCellFeed (string $location)

ListEntry getListEntry (string $location)

ListFeed getListFeed (mixed $location)

array getSpreadsheetCellFeedContents (mixed $location, [string $range = null], [boolean $empty = false])

SpreadsheetEntry getSpreadsheetEntry (string $location)

Zend_Gdata_Spreadsheets_SpreadsheetFeed getSpreadsheetFeed ([mixed $location = null])

array getSpreadsheetListFeedContents (mixed $location)

Zend_Gdata_Spreadsheets_SpreadsheetFeed getSpreadsheets ([mixed $location = null])

WorksheetEntry GetWorksheetEntry (string $location)

Zend_Gdata_Spreadsheets_WorksheetFeed getWorksheetFeed (mixed $location)

ListEntry insertRow (array $rowData, string $key, [string $wkshtId = 'default'])

CellEntry updateCell (int $row, int $col, int $inputValue, string $key, [string $wkshtId = 'default'])

void updateRow (ListEntry $entry, array $newRowData)

Variables

static array $namespaces = array(
array('gs', 'http://schemas.google.com/spreadsheets/2006', 1, 0),array('gsx','http://schemas.google.com/spreadsheets/2006/extended',1,0)) (line 109)

Namespaces used for Zend_Gdata_Photos

access: public

Redefinition of:

Zend_Gdata::$namespaces: Namespaces used for Gdata data

Inherited Variables

Inherited from Zend_Gdata

Zend_Gdata::$_defaultPostUri
Zend_Gdata::$_httpClient
Zend_Gdata::$_registeredPackages
Zend_Gdata::$_staticHttpClient

Inherited from Zend_Gdata_App

Zend_Gdata_App::$_gzipEnabled
Zend_Gdata_App::$_httpMethodOverride
Zend_Gdata_App::$_majorProtocolVersion
Zend_Gdata_App::$_maxRedirects
Zend_Gdata_App::$_minorProtocolVersion
Zend_Gdata_App::$_useObjectMapping
Zend_Gdata_App::$_verboseExceptionMessages

Methods

Constructor __construct (line 122)

Create Gdata_Spreadsheets object

access: public

Zend_Gdata_Spreadsheets __construct ([Zend_Http_Client $client = null], [string $applicationId = 'MyCompany-MyApp-1.0'])

Zend_Http_Client $client: (optional) The HTTP client to use when when communicating with the Google servers.
string $applicationId: The identity of the app in the form of Company-AppName-Version

Redefinition of:

Zend_Gdata::__construct(): Create Gdata object

deleteRow (line 363)

Deletes an existing row .

access: public

void deleteRow (ListEntry $entry)

ListEntry $entry: The row to delete

getCellEntry (line 239)

Gets a cell entry.

access: public

CellEntry getCellEntry (string $location)

string $location: A CellQuery or a URI specifying the entry location.

getCellFeed (line 221)

Gets a cell feed.

access: public

CellFeed getCellFeed (string $location)

string $location: A CellQuery, WorksheetEntry or a URI specifying the feed location.

getListEntry (line 275)

Gets a list entry.

access: public

ListEntry getListEntry (string $location)

string $location: A ListQuery or a URI specifying the entry location.

getListFeed (line 256)

Gets a list feed.

access: public

ListFeed getListFeed (mixed $location)

mixed $location: A ListQuery, WorksheetEntry or string URI specifying the feed location.

getSpreadsheetCellFeedContents (line 403)

Returns the content of all cells as an associative array, indexed off the cell location (ie 'A1', 'D4', etc). Each element of the array is an associative array with a 'value' and a 'function'.

Only non-empty cells are returned by default. 'range' is the value of the 'range' query parameter specified at: http://code.google.com/apis/spreadsheets/reference.html#cells_Parameters

return: An associative array of cells
access: public

array getSpreadsheetCellFeedContents (mixed $location, [string $range = null], [boolean $empty = false])

mixed $location: A CellQuery, WorksheetEntry or a URL (w/o query string) specifying the feed location.
string $range: The range of cells to retrieve
boolean $empty: Whether to retrieve empty cells

getSpreadsheetEntry (line 159)

Gets a spreadsheet entry.

access: public

SpreadsheetEntry getSpreadsheetEntry (string $location)

string $location: A DocumentQuery or a URI specifying the entry location.

getSpreadsheetFeed (line 137)

Gets a spreadsheet feed.

access: public

Zend_Gdata_Spreadsheets_SpreadsheetFeed getSpreadsheetFeed ([mixed $location = null])

mixed $location: A DocumentQuery or a string URI specifying the feed location.

getSpreadsheetListFeedContents (line 374)

Returns the content of all rows as an associative array

return: An array of rows. Each element of the array is an associative array of data
access: public

array getSpreadsheetListFeedContents (mixed $location)

mixed $location: A ListQuery or string URI specifying the feed location.

getSpreadsheets (line 440)

Alias for getSpreadsheetFeed

access: public

Zend_Gdata_Spreadsheets_SpreadsheetFeed getSpreadsheets ([mixed $location = null])

mixed $location: A DocumentQuery or a string URI specifying the feed location.

GetWorksheetEntry (line 201)

Gets a worksheet entry.

access: public

WorksheetEntry GetWorksheetEntry (string $location)

string $location: A DocumentQuery or a URI specifying the entry location.

getWorksheetFeed (line 179)

Gets a worksheet feed.

return: The feed of worksheets
access: public

Zend_Gdata_Spreadsheets_WorksheetFeed getWorksheetFeed (mixed $location)

mixed $location: A DocumentQuery, SpreadsheetEntry, or a string URI

insertRow (line 319)

Inserts a new row with provided data.

return: The inserted row
access: public

ListEntry insertRow (array $rowData, string $key, [string $wkshtId = 'default'])

array $rowData: An array of column header to row data
string $key: The key of the spreadsheet to modify
string $wkshtId: (optional) The worksheet to modify

updateCell (line 296)

Updates an existing cell.

return: The updated cell entry.
access: public

CellEntry updateCell (int $row, int $col, int $inputValue, string $key, [string $wkshtId = 'default'])

int $row: The row containing the cell to update
int $col: The column containing the cell to update
int $inputValue: The new value for the cell
string $key: The key for the spreadsheet to be updated
string $wkshtId: (optional) The worksheet to be updated

updateRow (line 345)

Updates an existing row with provided data.

access: public

void updateRow (ListEntry $entry, array $newRowData)

ListEntry $entry: The row entry to update
array $newRowData: An array of column header to row data

Inherited Methods

Inherited From Zend_Gdata

Zend_Gdata::__construct()
Zend_Gdata::getEntry()
Zend_Gdata::getFeed()
Zend_Gdata::import()
Zend_Gdata::isAuthenticated()
Zend_Gdata::performHttpRequest()

Inherited From Zend_Gdata_App

Zend_Gdata_App::__construct()
Zend_Gdata_App::delete()
Zend_Gdata_App::enableRequestDebugLogging()
Zend_Gdata_App::generateIfMatchHeaderData()
Zend_Gdata_App::get()
Zend_Gdata_App::getEntry()
Zend_Gdata_App::getFeed()
Zend_Gdata_App::getGzipEnabled()
Zend_Gdata_App::getHttpClient()
Zend_Gdata_App::getHttpMethodOverride()
Zend_Gdata_App::getMajorProtocolVersion()
Zend_Gdata_App::getMaxRedirects()
Zend_Gdata_App::getMinorProtocolVersion()
Zend_Gdata_App::getNextFeed()
Zend_Gdata_App::getPreviousFeed()
Zend_Gdata_App::getStaticHttpClient()
Zend_Gdata_App::getVerboseExceptionMessages()
Zend_Gdata_App::import()
Zend_Gdata_App::importFile()
Zend_Gdata_App::importString()
Zend_Gdata_App::importUrl()
Zend_Gdata_App::insertEntry()
Zend_Gdata_App::performHttpRequest()
Zend_Gdata_App::post()
Zend_Gdata_App::prepareRequest()
Zend_Gdata_App::put()
Zend_Gdata_App::registerPackage()
Zend_Gdata_App::retrieveAllEntriesForFeed()
Zend_Gdata_App::setGzipEnabled()
Zend_Gdata_App::setHttpClient()
Zend_Gdata_App::setHttpMethodOverride()
Zend_Gdata_App::setMajorProtocolVersion()
Zend_Gdata_App::setMaxRedirects()
Zend_Gdata_App::setMinorProtocolVersion()
Zend_Gdata_App::setStaticHttpClient()
Zend_Gdata_App::setVerboseExceptionMessages()
Zend_Gdata_App::updateEntry()
Zend_Gdata_App::useObjectMapping()
Zend_Gdata_App::usingObjectMapping()
Zend_Gdata_App::__call()

Class Constants

AUTH_SERVICE_NAME = 'wise' (line 102)

CELL_FEED_LINK_URI = 'http://schemas.google.com/spreadsheets/2006#cellsfeed' (line 101)

LIST_FEED_LINK_URI = 'http://schemas.google.com/spreadsheets/2006#listfeed' (line 100)

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

SPREADSHEETS_POST_URI = 'http://spreadsheets.google.com/feeds/spreadsheets/private/full' (line 98)

WORKSHEETS_FEED_LINK_URI = 'http://schemas.google.com/spreadsheets/2006#worksheetsfeed' (line 99)

Inherited Constants

Inherited from Zend_Gdata

Zend_Gdata::AUTH_SERVICE_NAME

Inherited from Zend_Gdata_App

Zend_Gdata_App::DEFAULT_MAJOR_PROTOCOL_VERSION
Zend_Gdata_App::DEFAULT_MINOR_PROTOCOL_VERSION