API Documentation

Zend/Gdata/Spreadsheets.php

Show: inherited
Table of Contents

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Gdata  
Subpackage
Spreadsheets  
Version
$Id: Spreadsheets.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Gdata_Spreadsheets

Package: Zend\Gdata\Spreadsheets

Gdata Spreadsheets

Parent(s)
\Zend_Gdata < \Zend_Gdata_App
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Link
http://code.google.com/apis/gdata/spreadsheets.html  

Constants

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

Properties

Propertypublicarray  $namespaces= 'array( array('gs''
static

Namespaces used for Zend_Gdata_Photos

Default valuearray( array('gs'Details
Type
array

Methods

methodpublicGetWorksheetEntry( string $location ) : \WorksheetEntry

Gets a worksheet entry.

Parameters
Name Type Description
$location string

A DocumentQuery or a URI specifying the entry location.

Returns
Type Description
\WorksheetEntry
methodpublic__construct( \Zend_Http_Client $client = null, string $applicationId = 'MyCompany-MyApp-1.0' ) : void

Create Gdata_Spreadsheets object

Parameters
Name Type Description
$client \Zend_Http_Client

(optional) The HTTP client to use when when communicating with the Google servers.

$applicationId string

The identity of the app in the form of Company-AppName-Version

methodpublicdeleteRow( \ListEntry $entry ) : void

Deletes an existing row .

Parameters
Name Type Description
$entry \ListEntry

The row to delete

methodpublicgetCellEntry( string $location ) : \CellEntry

Gets a cell entry.

Parameters
Name Type Description
$location string

A CellQuery or a URI specifying the entry location.

Returns
Type Description
\CellEntry
methodpublicgetCellFeed( string $location ) : \CellFeed

Gets a cell feed.

Parameters
Name Type Description
$location string

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

Returns
Type Description
\CellFeed
methodpublicgetListEntry( string $location ) : \ListEntry

Gets a list entry.

Parameters
Name Type Description
$location string

A ListQuery or a URI specifying the entry location.

Returns
Type Description
\ListEntry
methodpublicgetListFeed( mixed $location ) : \ListFeed

Gets a list feed.

Parameters
Name Type Description
$location mixed

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

Returns
Type Description
\ListFeed
methodpublicgetSpreadsheetCellFeedContents( mixed $location, string $range = null, boolean $empty = false ) : array

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
Name Type Description
$location mixed

A CellQuery, WorksheetEntry or a URL (w/o query string) specifying the feed location.

$range string

The range of cells to retrieve

$empty boolean

Whether to retrieve empty cells

Returns
Type Description
array An associative array of cells
methodpublicgetSpreadsheetEntry( string $location ) : \SpreadsheetEntry

Gets a spreadsheet entry.

Parameters
Name Type Description
$location string

A DocumentQuery or a URI specifying the entry location.

Returns
Type Description
\SpreadsheetEntry
methodpublicgetSpreadsheetFeed( mixed $location = null ) : \Zend_Gdata_Spreadsheets_SpreadsheetFeed

Gets a spreadsheet feed.

Parameters
Name Type Description
$location mixed

A DocumentQuery or a string URI specifying the feed location.

Returns
Type Description
\Zend_Gdata_Spreadsheets_SpreadsheetFeed
methodpublicgetSpreadsheetListFeedContents( mixed $location ) : array

Returns the content of all rows as an associative array

Parameters
Name Type Description
$location mixed

A ListQuery or string URI specifying the feed location.

Returns
Type Description
array An array of rows. Each element of the array is an associative array of data
methodpublicgetSpreadsheets( mixed $location = null ) : \Zend_Gdata_Spreadsheets_SpreadsheetFeed

Alias for getSpreadsheetFeed

Parameters
Name Type Description
$location mixed

A DocumentQuery or a string URI specifying the feed location.

Returns
Type Description
\Zend_Gdata_Spreadsheets_SpreadsheetFeed
methodpublicgetWorksheetFeed( mixed $location ) : \Zend_Gdata_Spreadsheets_WorksheetFeed

Gets a worksheet feed.

Parameters
Name Type Description
$location mixed

A DocumentQuery, SpreadsheetEntry, or a string URI

Returns
Type Description
\Zend_Gdata_Spreadsheets_WorksheetFeed The feed of worksheets
methodpublicinsertRow( array $rowData, string $key, string $wkshtId = 'default' ) : \ListEntry

Inserts a new row with provided data.

Parameters
Name Type Description
$rowData array

An array of column header to row data

$key string

The key of the spreadsheet to modify

$wkshtId string

(optional) The worksheet to modify

Returns
Type Description
\ListEntry The inserted row
methodpublicupdateCell( int $row, int $col, int $inputValue, string $key, string $wkshtId = 'default' ) : \CellEntry

Updates an existing cell.

Parameters
Name Type Description
$row int

The row containing the cell to update

$col int

The column containing the cell to update

$inputValue int

The new value for the cell

$key string

The key for the spreadsheet to be updated

$wkshtId string

(optional) The worksheet to be updated

Returns
Type Description
\CellEntry The updated cell entry.
methodpublicupdateRow( \ListEntry $entry, array $newRowData ) : void

Updates an existing row with provided data.

Parameters
Name Type Description
$entry \ListEntry

The row entry to update

$newRowData array

An array of column header to row data

Documentation was generated by DocBlox 0.15.1.