Moodle  2.2.1
http://www.collinsharper.com
Zend_Gdata_Spreadsheets Class Reference
Inheritance diagram for Zend_Gdata_Spreadsheets:
Collaboration diagram for Zend_Gdata_Spreadsheets:

Public Member Functions

 __construct ($client=null, $applicationId= 'MyCompany-MyApp-1.0')
 getSpreadsheetFeed ($location=null)
 getSpreadsheetEntry ($location)
 getWorksheetFeed ($location)
 GetWorksheetEntry ($location)
 getCellFeed ($location)
 getCellEntry ($location)
 getListFeed ($location)
 getListEntry ($location)
 updateCell ($row, $col, $inputValue, $key, $wkshtId= 'default')
 insertRow ($rowData, $key, $wkshtId= 'default')
 updateRow ($entry, $newRowData)
 deleteRow ($entry)
 getSpreadsheetListFeedContents ($location)
 getSpreadsheetCellFeedContents ($location, $range=null, $empty=false)
 getSpreadsheets ($location=null)

Data Fields

const SPREADSHEETS_FEED_URI = 'http://spreadsheets.google.com/feeds/spreadsheets'
const SPREADSHEETS_POST_URI = 'http://spreadsheets.google.com/feeds/spreadsheets/private/full'
const WORKSHEETS_FEED_LINK_URI = 'http://schemas.google.com/spreadsheets/2006#worksheetsfeed'
const LIST_FEED_LINK_URI = 'http://schemas.google.com/spreadsheets/2006#listfeed'
const CELL_FEED_LINK_URI = 'http://schemas.google.com/spreadsheets/2006#cellsfeed'
const AUTH_SERVICE_NAME = 'wise'

Static Public Attributes

static $namespaces

Detailed Description

Definition at line 95 of file Spreadsheets.php.


Constructor & Destructor Documentation

__construct ( client = null,
applicationId = 'MyCompany-MyApp-1.0' 
)

Create Gdata_Spreadsheets object

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

Reimplemented from Zend_Gdata.

Definition at line 122 of file Spreadsheets.php.

Here is the call graph for this function:


Member Function Documentation

deleteRow ( entry)

Deletes an existing row .

Parameters:
ListEntry$entryThe row to delete

Definition at line 363 of file Spreadsheets.php.

getCellEntry ( location)

Gets a cell entry.

Parameters:
string$locationA CellQuery or a URI specifying the entry location.
Returns:
CellEntry

Definition at line 239 of file Spreadsheets.php.

Here is the call graph for this function:

Here is the caller graph for this function:

getCellFeed ( location)

Gets a cell feed.

Parameters:
string$locationA CellQuery, WorksheetEntry or a URI specifying the feed location.
Returns:
CellFeed

Definition at line 221 of file Spreadsheets.php.

Here is the call graph for this function:

Here is the caller graph for this function:

getListEntry ( location)

Gets a list entry.

Parameters:
string$locationA ListQuery or a URI specifying the entry location.
Returns:
ListEntry

Definition at line 275 of file Spreadsheets.php.

Here is the call graph for this function:

getListFeed ( location)

Gets a list feed.

Parameters:
mixed$locationA ListQuery, WorksheetEntry or string URI specifying the feed location.
Returns:
ListFeed

Definition at line 256 of file Spreadsheets.php.

Here is the call graph for this function:

Here is the caller graph for this function:

getSpreadsheetCellFeedContents ( location,
range = null,
empty = false 
)

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

Parameters:
mixed$locationA CellQuery, WorksheetEntry or a URL (w/o query string) specifying the feed location.
string$rangeThe range of cells to retrieve
boolean$emptyWhether to retrieve empty cells
Returns:
array An associative array of cells

Definition at line 403 of file Spreadsheets.php.

Here is the call graph for this function:

getSpreadsheetEntry ( location)

Gets a spreadsheet entry.

Parameters:
string$locationA DocumentQuery or a URI specifying the entry location.
Returns:
SpreadsheetEntry

Definition at line 159 of file Spreadsheets.php.

Here is the call graph for this function:

getSpreadsheetFeed ( location = null)

Gets a spreadsheet feed.

Parameters:
mixed$locationA DocumentQuery or a string URI specifying the feed location.
Returns:
Zend_Gdata_Spreadsheets_SpreadsheetFeed

Definition at line 137 of file Spreadsheets.php.

Here is the call graph for this function:

Here is the caller graph for this function:

Returns the content of all rows as an associative array

Parameters:
mixed$locationA ListQuery or string URI specifying the feed location.
Returns:
array An array of rows. Each element of the array is an associative array of data

Definition at line 374 of file Spreadsheets.php.

Here is the call graph for this function:

getSpreadsheets ( location = null)

Alias for getSpreadsheetFeed

Parameters:
mixed$locationA DocumentQuery or a string URI specifying the feed location.
Returns:
Zend_Gdata_Spreadsheets_SpreadsheetFeed

Definition at line 440 of file Spreadsheets.php.

Here is the call graph for this function:

GetWorksheetEntry ( location)

Gets a worksheet entry.

Parameters:
string$locationA DocumentQuery or a URI specifying the entry location.
Returns:
WorksheetEntry

Definition at line 201 of file Spreadsheets.php.

Here is the call graph for this function:

getWorksheetFeed ( location)

Gets a worksheet feed.

Parameters:
mixed$locationA DocumentQuery, SpreadsheetEntry, or a string URI
Returns:
Zend_Gdata_Spreadsheets_WorksheetFeed The feed of worksheets

Definition at line 179 of file Spreadsheets.php.

Here is the call graph for this function:

insertRow ( rowData,
key,
wkshtId = 'default' 
)

Inserts a new row with provided data.

Parameters:
array$rowDataAn array of column header to row data
string$keyThe key of the spreadsheet to modify
string$wkshtId(optional) The worksheet to modify
Returns:
ListEntry The inserted row

Definition at line 319 of file Spreadsheets.php.

Here is the call graph for this function:

updateCell ( row,
col,
inputValue,
key,
wkshtId = 'default' 
)

Updates an existing cell.

Parameters:
int$rowThe row containing the cell to update
int$colThe column containing the cell to update
int$inputValueThe new value for the cell
string$keyThe key for the spreadsheet to be updated
string$wkshtId(optional) The worksheet to be updated
Returns:
CellEntry The updated cell entry.

Definition at line 296 of file Spreadsheets.php.

Here is the call graph for this function:

updateRow ( entry,
newRowData 
)

Updates an existing row with provided data.

Parameters:
ListEntry$entryThe row entry to update
array$newRowDataAn array of column header to row data

Definition at line 345 of file Spreadsheets.php.


Field Documentation

$namespaces [static]
Initial value:
 array(
        array('gs', 'http://schemas.google.com/spreadsheets/2006', 1, 0),
        array(
            'gsx', 'http://schemas.google.com/spreadsheets/2006/extended', 1, 0)
    )

Reimplemented from Zend_Gdata.

Definition at line 109 of file Spreadsheets.php.

const AUTH_SERVICE_NAME = 'wise'

Reimplemented from Zend_Gdata.

Definition at line 102 of file Spreadsheets.php.

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

Definition at line 101 of file Spreadsheets.php.

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

Definition at line 100 of file Spreadsheets.php.

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

Definition at line 97 of file Spreadsheets.php.

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

Definition at line 98 of file Spreadsheets.php.

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

Definition at line 99 of file Spreadsheets.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations