Gdata/Spreadsheets.php

category: Zend
copyright: Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Gdata
subpackage: Spreadsheets
version: $Id: Spreadsheets.php 23805 2011-03-16 00:55:40Z tjohns $
Classes: Zend_Gdata_Spreadsheets

Description

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.

Zend_Gdata_Spreadsheets
jump to top

Extends from: Zend_Gdata
category: Zend
copyright: Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
link: http://code.google.com/apis/gdata/spreadsheets.html
package: Zend_Gdata
subpackage: Spreadsheets
Constants: SPREADSHEETS_FEED_URI; SPREADSHEETS_POST_URI; WORKSHEETS_FEED_LINK_URI; LIST_FEED_LINK_URI; CELL_FEED_LINK_URI; AUTH_SERVICE_NAME
Properties: $namespaces
Methods: __construct; getSpreadsheetFeed; getSpreadsheetEntry; getWorksheetFeed; GetWorksheetEntry; getCellFeed; getCellEntry; getListFeed; getListEntry; updateCell; insertRow; updateRow; deleteRow; getSpreadsheetListFeedContents; getSpreadsheetCellFeedContents; getSpreadsheets

Description

Gdata Spreadsheets

Constants

SPREADSHEETS_FEED_URI
jump to class

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

Details

value: https://spreadsheets.google.com/feeds/spreadsheets

SPREADSHEETS_POST_URI
jump to class

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

Details

value: https://spreadsheets.google.com/feeds/spreadsheets/private/full

WORKSHEETS_FEED_LINK_URI
jump to class

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

Details

value: http://schemas.google.com/spreadsheets/2006#worksheetsfeed

LIST_FEED_LINK_URI
jump to class

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

Details

value: http://schemas.google.com/spreadsheets/2006#listfeed

CELL_FEED_LINK_URI
jump to class

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

Details

value: http://schemas.google.com/spreadsheets/2006#cellsfeed

AUTH_SERVICE_NAME
jump to class

 AUTH_SERVICE_NAME = 'wise'

Details

value: wise

Properties

$namespaces
jump to class

array $namespaces = 'array'

Namespaces used for Zend_Gdata_Photos

Details

$namespaces: array
visibility: public
default: array
final: false
static: true

Methods

GetWorksheetEntry
jump to class

GetWorksheetEntry(
          string $location
          )
        
        :
        WorksheetEntry

Gets a worksheet entry.

Arguments

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

Output

WorksheetEntry

Details

visibility: public
final: false
static: false

__construct
jump to class

__construct(
          Zend_Http_Client $client
              =
              null, string $applicationId
              =
              MyCompany-MyApp-1.0
          )
        
        :

Create Gdata_Spreadsheets object

Arguments

$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

Details

visibility: public
final: false
static: false

deleteRow
jump to class

deleteRow(
          ListEntry $entry
          )
        
        :

Deletes an existing row .

Arguments

$entry: ListEntry
The row to delete

Details

visibility: public
final: false
static: false

getCellEntry
jump to class

getCellEntry(
          string $location
          )
        
        :
        CellEntry

Gets a cell entry.

Arguments

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

Output

CellEntry

Details

visibility: public
final: false
static: false

getCellFeed
jump to class

getCellFeed(
          string $location
          )
        
        :
        CellFeed

Gets a cell feed.

Arguments

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

Output

CellFeed

Details

visibility: public
final: false
static: false

getListEntry
jump to class

getListEntry(
          string $location
          )
        
        :
        ListEntry

Gets a list entry.

Arguments

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

Output

ListEntry

Details

visibility: public
final: false
static: false

getListFeed
jump to class

getListFeed(
          mixed $location
          )
        
        :
        ListFeed

Gets a list feed.

Arguments

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

Output

ListFeed

Details

visibility: public
final: false
static: false

getSpreadsheetCellFeedContents
jump to class

getSpreadsheetCellFeedContents(
          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

Arguments

$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

Output

array: An associative array of cells

Details

visibility: public
final: false
static: false

getSpreadsheetEntry
jump to class

getSpreadsheetEntry(
          string $location
          )
        
        :
        SpreadsheetEntry

Gets a spreadsheet entry.

Arguments

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

Output

SpreadsheetEntry

Details

visibility: public
final: false
static: false

getSpreadsheetFeed
jump to class

getSpreadsheetFeed(
          mixed $location
              =
              null
          )
        
        :
        Zend_Gdata_Spreadsheets_SpreadsheetFeed

Gets a spreadsheet feed.

Arguments

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

Output

Zend_Gdata_Spreadsheets_SpreadsheetFeed

Details

visibility: public
final: false
static: false

getSpreadsheetListFeedContents
jump to class

getSpreadsheetListFeedContents(
          mixed $location
          )
        
        :
        array

Returns the content of all rows as an associative array

Arguments

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

Output

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

Details

visibility: public
final: false
static: false

getSpreadsheets
jump to class

getSpreadsheets(
          mixed $location
              =
              null
          )
        
        :
        Zend_Gdata_Spreadsheets_SpreadsheetFeed

Alias for getSpreadsheetFeed

Arguments

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

Output

Zend_Gdata_Spreadsheets_SpreadsheetFeed

Details

visibility: public
final: false
static: false

getWorksheetFeed
jump to class

getWorksheetFeed(
          mixed $location
          )
        
        :
        Zend_Gdata_Spreadsheets_WorksheetFeed

Gets a worksheet feed.

Arguments

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

Output

Zend_Gdata_Spreadsheets_WorksheetFeed: The feed of worksheets

Details

visibility: public
final: false
static: false

insertRow
jump to class

insertRow(
          array $rowData, string $key, string $wkshtId
              =
              default
          )
        
        :
        ListEntry

Inserts a new row with provided data.

Arguments

$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

Output

ListEntry: The inserted row

Details

visibility: public
final: false
static: false

updateCell
jump to class

updateCell(
          int $row, int $col, int $inputValue, string $key, string $wkshtId
              =
              default
          )
        
        :
        CellEntry

Updates an existing cell.

Arguments

$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

Output

CellEntry: The updated cell entry.

Details

visibility: public
final: false
static: false

updateRow
jump to class

updateRow(
          ListEntry $entry, array $newRowData
          )
        
        :

Updates an existing row with provided data.

Arguments

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

Details

visibility: public
final: false
static: false

API Documentation

Gdata/Spreadsheets.php

Description

Zend_Gdata_Spreadsheetsjump to top

Description

Constants

SPREADSHEETS_FEED_URIjump to class

Details

SPREADSHEETS_POST_URIjump to class

Details

WORKSHEETS_FEED_LINK_URIjump to class

Details

LIST_FEED_LINK_URIjump to class

Details

CELL_FEED_LINK_URIjump to class

Details

AUTH_SERVICE_NAMEjump to class

Details

Properties

$namespacesjump to class

Details

Methods

GetWorksheetEntryjump to class

Arguments

Output

Details

__constructjump to class

Arguments

Details

deleteRowjump to class

Arguments

Details

getCellEntryjump to class

Arguments

Output

Details

getCellFeedjump to class

Arguments

Output

Details

getListEntryjump to class

Arguments

Output

Details

getListFeedjump to class

Arguments

Output

Details

getSpreadsheetCellFeedContentsjump to class

Arguments

Output

Details

getSpreadsheetEntryjump to class

Arguments

Output

Details

getSpreadsheetFeedjump to class

Arguments

Output

Details

getSpreadsheetListFeedContentsjump to class

Arguments

Output

Details

getSpreadsheetsjump to class

Arguments

Output

Details

getWorksheetFeedjump to class

Arguments

Output

Details

insertRowjump to class

Arguments

Output

Details

updateCelljump to class

Arguments

Output

Details

Zend_Gdata_Spreadsheets
jump to top

SPREADSHEETS_FEED_URI
jump to class

SPREADSHEETS_POST_URI
jump to class

WORKSHEETS_FEED_LINK_URI
jump to class

LIST_FEED_LINK_URI
jump to class

CELL_FEED_LINK_URI
jump to class

AUTH_SERVICE_NAME
jump to class

$namespaces
jump to class

GetWorksheetEntry
jump to class

__construct
jump to class

deleteRow
jump to class

getCellEntry
jump to class

getCellFeed
jump to class

getListEntry
jump to class

getListFeed
jump to class

getSpreadsheetCellFeedContents
jump to class

getSpreadsheetEntry
jump to class

getSpreadsheetFeed
jump to class

getSpreadsheetListFeedContents
jump to class

getSpreadsheets
jump to class

getWorksheetFeed
jump to class

insertRow
jump to class

updateCell
jump to class

updateRow
jump to class