Gdata/Spreadsheets.php

Show: PublicProtectedPrivateinherited
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 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Gdata_Spreadsheets

Package: Zend\Gdata\Spreadsheets
Gdata Spreadsheets

As the Google data API protocol is based upon the Atom Publishing Protocol (APP), Gdata functionality extends the appropriate Zend_Gdata_App classes

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

>VConstant  SPREADSHEETS_FEED_URI = 'https://spreadsheets.google.com/feeds/spreadsheets'
>VConstant  SPREADSHEETS_POST_URI = 'https://spreadsheets.google.com/feeds/spreadsheets/private/full'
>VConstant  WORKSHEETS_FEED_LINK_URI = 'http://schemas.google.com/spreadsheets/2006#worksheetsfeed'
>VConstant  LIST_FEED_LINK_URI = 'http://schemas.google.com/spreadsheets/2006#listfeed'
>VConstant  CELL_FEED_LINK_URI = 'http://schemas.google.com/spreadsheets/2006#cellsfeed'
>VConstantstring  AUTH_SERVICE_NAME = 'wise'
Service name for use with Google's authentication mechanisms
string

>VConstant  DEFAULT_MAJOR_PROTOCOL_VERSION = 1
Inherited_from
\Zend_Gdata_App::DEFAULT_MAJOR_PROTOCOL_VERSION  
Inherited_from
\Zend_Gdata::DEFAULT_MAJOR_PROTOCOL_VERSION  
See
\_majorProtocolVersion  
>VConstant  DEFAULT_MINOR_PROTOCOL_VERSION = null
Inherited_from
\Zend_Gdata_App::DEFAULT_MINOR_PROTOCOL_VERSION  
Inherited_from
\Zend_Gdata::DEFAULT_MINOR_PROTOCOL_VERSION  
See
\_minorProtocolVersion  

Properties

>VPropertyprotectedstring $_defaultPostUri = null
inherited
Default URI to which to POST.
Inherited from: \Zend_Gdata::$$_defaultPostUri
Default valuenullDetails
Type
string
Inherited_from
\Zend_Gdata::$$_defaultPostUri  
>VPropertyprotectedboolean $_gzipEnabled = false
staticinherited
Enable gzipped responses?
Inherited from: \Zend_Gdata_App::$$_gzipEnabled\Zend_Gdata::$$_gzipEnabled
Default valuefalseDetails
Type
boolean
Inherited_from
\Zend_Gdata_App::$$_gzipEnabled  
Inherited_from
\Zend_Gdata::$$_gzipEnabled  
>VPropertyprotected\Zend_Gdata_HttpClient $_httpClient
inherited
Client object used to communicate
Inherited from: \Zend_Gdata::$$_httpClient
>VPropertyprotectedboolean $_httpMethodOverride = false
staticinherited
Override HTTP PUT and DELETE request methods?
Inherited from: \Zend_Gdata_App::$$_httpMethodOverride\Zend_Gdata::$$_httpMethodOverride
Default valuefalseDetails
Type
boolean
Inherited_from
\Zend_Gdata_App::$$_httpMethodOverride  
Inherited_from
\Zend_Gdata::$$_httpMethodOverride  
>VPropertyprotected$_majorProtocolVersion
inherited
Indicates the major protocol version that should be used.
Inherited from: \Zend_Gdata_App::$$_majorProtocolVersion\Zend_Gdata::$$_majorProtocolVersion

At present, recognized values are either 1 or 2. However, any integer value >= 1 is considered valid.

Under most circumtances, this will be automatically set by Zend_Gdata_App subclasses.

Details
Type
n/a
Inherited_from
\Zend_Gdata_App::$$_majorProtocolVersion  
Inherited_from
\Zend_Gdata::$$_majorProtocolVersion  
See
\setMajorProtocolVersion()  
See
\getMajorProtocolVersion()  
>VPropertyprotectedint $_maxRedirects = 5
staticinherited
Maximum number of redirects to follow during HTTP operations
Inherited from: \Zend_Gdata_App::$$_maxRedirects\Zend_Gdata::$$_maxRedirects
Default value5Details
Type
int
Inherited_from
\Zend_Gdata_App::$$_maxRedirects  
Inherited_from
\Zend_Gdata::$$_maxRedirects  
>VPropertyprotected$_minorProtocolVersion
inherited
Indicates the minor protocol version that should be used.
Inherited from: \Zend_Gdata_App::$$_minorProtocolVersion\Zend_Gdata::$$_minorProtocolVersion

Can be set to either an integer >= 0, or NULL if no minor version should be sent to the server.

At present, this field is not used by any Google services, but may be used in the future.

Under most circumtances, this will be automatically set by Zend_Gdata_App subclasses.

Details
Type
n/a
Inherited_from
\Zend_Gdata_App::$$_minorProtocolVersion  
Inherited_from
\Zend_Gdata::$$_minorProtocolVersion  
See
\setMinorProtocolVersion()  
See
\getMinorProtocolVersion()  
>VPropertyprotectedarray $_registeredPackages = array('Zend_Gdata_Kind', 'Zend_Gdata_Extension', 'Zend_Gdata', 'Zend_Gdata_App_Extension', 'Zend_Gdata_App')
inherited
Packages to search for classes when using magic __call method, in order.
Inherited from: \Zend_Gdata::$$_registeredPackages
Default valuearray('Zend_Gdata_Kind', 'Zend_Gdata_Extension', 'Zend_Gdata', 'Zend_Gdata_App_Extension', 'Zend_Gdata_App')Details
Type
array
Inherited_from
\Zend_Gdata::$$_registeredPackages  
>VPropertyprotected\Zend_Gdata_HttpClient $_staticHttpClient = null
staticinherited
Client object used to communicate in static context
Inherited from: \Zend_Gdata::$$_staticHttpClient
Default valuenullDetails
Type
\Zend_Gdata_HttpClient
Inherited_from
\Zend_Gdata::$$_staticHttpClient  
>VPropertyprotectedboolean $_useObjectMapping = true
inherited
Whether we want to use XML to object mapping when fetching data.
Inherited from: \Zend_Gdata_App::$$_useObjectMapping\Zend_Gdata::$$_useObjectMapping
Default valuetrueDetails
Type
boolean
Inherited_from
\Zend_Gdata_App::$$_useObjectMapping  
Inherited_from
\Zend_Gdata::$$_useObjectMapping  
>VPropertyprotectedboolean $_verboseExceptionMessages = true
staticinherited
Use verbose exception messages.
Inherited from: \Zend_Gdata_App::$$_verboseExceptionMessages\Zend_Gdata::$$_verboseExceptionMessages

In the case of HTTP errors, use the body of the HTTP response in the exception message.

Default valuetrueDetails
Type
boolean
Inherited_from
\Zend_Gdata_App::$$_verboseExceptionMessages  
Inherited_from
\Zend_Gdata::$$_verboseExceptionMessages  
>VPropertypublicarray $namespaces = array(array('gs', 'http://schemas.google.com/spreadsheets/2006', 1, 0), array('gsx', 'http://schemas.google.com/spreadsheets/2006/extended', 1, 0))
static
Namespaces used for Zend_Gdata_Photos
Default valuearray(array('gs', 'http://schemas.google.com/spreadsheets/2006', 1, 0), array('gsx', 'http://schemas.google.com/spreadsheets/2006/extended', 1, 0))Details
Type
array

Methods

methodpublicGetWorksheetEntry(string $location) : \WorksheetEntry

Gets a worksheet entry.

Parameters
NameTypeDescription
$locationstring

A DocumentQuery or a URI specifying the entry location.

Returns
TypeDescription
\WorksheetEntry
methodpublic__call(string $method, array $args) : void
inherited

Provides a magic factory method to instantiate new objects with shorter syntax than would otherwise be required by the Zend Framework naming conventions.

Inherited from: \Zend_Gdata_App::__call()\Zend_Gdata::__call()

For instance, to construct a new Zend_Gdata_Calendar_Extension_Color, a developer simply needs to do $gCal->newColor(). For this magic constructor, packages are searched in the same order as which they appear in the $_registeredPackages array

Parameters
NameTypeDescription
$methodstring

The method name being called

$argsarray

The arguments passed to the call

Throws
ExceptionDescription
\Zend_Gdata_App_Exception
methodpublic__construct(\Zend_Http_Client $client = null, string $applicationId = 'MyCompany-MyApp-1.0') : void

Create Gdata_Spreadsheets object

Parameters
NameTypeDescription
$client\Zend_Http_Client

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

$applicationIdstring

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

methodpublicdelete(mixed $data,  $remainingRedirects = null) : void
inherited

DELETE entry with client object

Inherited from: \Zend_Gdata_App::delete()\Zend_Gdata::delete()
Parameters
NameTypeDescription
$datamixed

The Zend_Gdata_App_Entry or URL to delete

$remainingRedirects
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_App_InvalidArgumentException
methodpublicdeleteRow(\ListEntry $entry) : void

Deletes an existing row .

Parameters
NameTypeDescription
$entry\ListEntry

The row to delete

methodpublicenableRequestDebugLogging(string $logfile) : void
inherited

This method enables logging of requests by changing the Zend_Http_Client_Adapter used for performing the requests.

Inherited from: \Zend_Gdata_App::enableRequestDebugLogging()\Zend_Gdata::enableRequestDebugLogging()

NOTE: This will not work if you have customized the adapter already to use a proxy server or other interface.

Parameters
NameTypeDescription
$logfilestring

The logfile to use when logging the requests

methodpublicgenerateIfMatchHeaderData( $data,  $allowWeek) : string | null
inherited

Returns the data for an If-Match header based on the current Etag property.

Inherited from: \Zend_Gdata_App::generateIfMatchHeaderData()\Zend_Gdata::generateIfMatchHeaderData()

If Etags are not supported by the server or cannot be extracted from the data, then null will be returned.

Parameters
NameTypeDescription
$data
$allowWeek
Returns
TypeDescription
string | null$data
methodpublicget(string $uri, array $extraHeaders = array()) : \Zend_Http_Response
inherited

GET a URI using client object.

Inherited from: \Zend_Gdata_App::get()\Zend_Gdata::get()
Parameters
NameTypeDescription
$uristring

GET URI

$extraHeadersarray

Extra headers to add to the request, as an array of string-based key/value pairs.

Returns
TypeDescription
\Zend_Http_Response
Throws
ExceptionDescription
\Zend_Gdata_App_HttpException
methodpublicgetCellEntry(string $location) : \CellEntry

Gets a cell entry.

Parameters
NameTypeDescription
$locationstring

A CellQuery or a URI specifying the entry location.

Returns
TypeDescription
\CellEntry
methodpublicgetCellFeed(string $location) : \CellFeed

Gets a cell feed.

Parameters
NameTypeDescription
$locationstring

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

Returns
TypeDescription
\CellFeed
methodpublicgetEntry(mixed $location,  $className = 'Zend_Gdata_Entry') : string | \Zend_Gdata_App_Entry
inherited

Retrieve entry as string or object

Inherited from: \Zend_Gdata::getEntry()
Parameters
NameTypeDescription
$locationmixed

The location as string or Zend_Gdata_Query

$className
Returns
TypeDescription
string | \Zend_Gdata_App_EntryReturns string only if the object mapping has been disabled explicitly by passing false to the useObjectMapping() function.
Throws
ExceptionDescription
\Zend_Gdata_App_InvalidArgumentException
methodpublicgetFeed(mixed $location, string $className = 'Zend_Gdata_Feed') : string | \Zend_Gdata_App_Feed
inherited

Retrieve feed as string or object

Inherited from: \Zend_Gdata::getFeed()
Parameters
NameTypeDescription
$locationmixed

The location as string or Zend_Gdata_Query

$classNamestring

The class type to use for returning the feed

Returns
TypeDescription
string | \Zend_Gdata_App_FeedReturns string only if the object mapping has been disabled explicitly by passing false to the useObjectMapping() function.
Throws
ExceptionDescription
\Zend_Gdata_App_InvalidArgumentException
methodpublicgetGzipEnabled() : boolean
staticinherited

Get the HTTP override state

Inherited from: \Zend_Gdata_App::getGzipEnabled()\Zend_Gdata::getGzipEnabled()
Returns
TypeDescription
boolean
methodpublicgetHttpClient() : \Zend_Http_Client
inherited

Get the Zend_Http_Client object used for communication

Inherited from: \Zend_Gdata_App::getHttpClient()\Zend_Gdata::getHttpClient()
Returns
TypeDescription
\Zend_Http_Client
methodpublicgetHttpMethodOverride() : boolean
staticinherited

Get the HTTP override state

Inherited from: \Zend_Gdata_App::getHttpMethodOverride()\Zend_Gdata::getHttpMethodOverride()
Returns
TypeDescription
boolean
methodpublicgetListEntry(string $location) : \ListEntry

Gets a list entry.

Parameters
NameTypeDescription
$locationstring

A ListQuery or a URI specifying the entry location.

Returns
TypeDescription
\ListEntry
methodpublicgetListFeed(mixed $location) : \ListFeed

Gets a list feed.

Parameters
NameTypeDescription
$locationmixed

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

Returns
TypeDescription
\ListFeed
methodpublicgetMajorProtocolVersion() : int
inherited

Get the major protocol version that is in use.

Inherited from: \Zend_Gdata_App::getMajorProtocolVersion()\Zend_Gdata::getMajorProtocolVersion()
Returns
TypeDescription
intThe major protocol version in use.
Details
See
\_majorProtocolVersion  
methodpublicgetMaxRedirects() : int
staticinherited

Get the maximum number of redirects to follow during HTTP operations

Inherited from: \Zend_Gdata_App::getMaxRedirects()\Zend_Gdata::getMaxRedirects()
Returns
TypeDescription
intMaximum number of redirects to follow
methodpublicgetMinorProtocolVersion() : \(int | \NULL)
inherited

Get the minor protocol version that is in use.

Inherited from: \Zend_Gdata_App::getMinorProtocolVersion()\Zend_Gdata::getMinorProtocolVersion()
Returns
TypeDescription
\(int | \NULL)The major protocol version in use, or NULL if no minor version is specified.
Details
See
\_minorProtocolVersion  
methodpublicgetNextFeed(\Zend_Gdata_App_Feed $feed, string $className = null) : \Zend_Gdata_App_Feed | null
inherited

Retrieve next set of results based on a given feed.

Inherited from: \Zend_Gdata_App::getNextFeed()\Zend_Gdata::getNextFeed()
Parameters
NameTypeDescription
$feed\Zend_Gdata_App_Feed

The feed from which to retreive the next set of results.

$classNamestring

(optional) The class of feed to be returned. If null, the next feed (if found) will be the same class as the feed that was given as the first argument.

Returns
TypeDescription
\Zend_Gdata_App_Feed | nullReturns a Zend_Gdata_App_Feed or null if no next set of results exists.
methodpublicgetPreviousFeed(\Zend_Gdata_App_Feed $feed, string $className = null) : \Zend_Gdata_App_Feed | null
inherited

Retrieve previous set of results based on a given feed.

Inherited from: \Zend_Gdata_App::getPreviousFeed()\Zend_Gdata::getPreviousFeed()
Parameters
NameTypeDescription
$feed\Zend_Gdata_App_Feed

The feed from which to retreive the previous set of results.

$classNamestring

(optional) The class of feed to be returned. If null, the previous feed (if found) will be the same class as the feed that was given as the first argument.

Returns
TypeDescription
\Zend_Gdata_App_Feed | nullReturns a Zend_Gdata_App_Feed or null if no previous set of results exists.
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
NameTypeDescription
$locationmixed

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

$rangestring

The range of cells to retrieve

$emptyboolean

Whether to retrieve empty cells

Returns
TypeDescription
arrayAn associative array of cells
methodpublicgetSpreadsheetEntry(string $location) : \SpreadsheetEntry

Gets a spreadsheet entry.

Parameters
NameTypeDescription
$locationstring

A DocumentQuery or a URI specifying the entry location.

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

Gets a spreadsheet feed.

Parameters
NameTypeDescription
$locationmixed

A DocumentQuery or a string URI specifying the feed location.

Returns
TypeDescription
\Zend_Gdata_Spreadsheets_SpreadsheetFeed
methodpublicgetSpreadsheetListFeedContents(mixed $location) : array

Returns the content of all rows as an associative array

Parameters
NameTypeDescription
$locationmixed

A ListQuery or string URI specifying the feed location.

Returns
TypeDescription
arrayAn 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
NameTypeDescription
$locationmixed

A DocumentQuery or a string URI specifying the feed location.

Returns
TypeDescription
\Zend_Gdata_Spreadsheets_SpreadsheetFeed
methodpublicgetStaticHttpClient() : \Zend_Http_Client
staticinherited

Gets the HTTP client object.

Inherited from: \Zend_Gdata_App::getStaticHttpClient()\Zend_Gdata::getStaticHttpClient()

If none is set, a new Zend_Http_Client will be used.

Returns
TypeDescription
\Zend_Http_Client
methodpublicgetVerboseExceptionMessages() : boolean
staticinherited

Get whether to use verbose exception messages

Inherited from: \Zend_Gdata_App::getVerboseExceptionMessages()\Zend_Gdata::getVerboseExceptionMessages()

In the case of HTTP errors, use the body of the HTTP response in the exception message.

Returns
TypeDescription
boolean
methodpublicgetWorksheetFeed(mixed $location) : \Zend_Gdata_Spreadsheets_WorksheetFeed

Gets a worksheet feed.

Parameters
NameTypeDescription
$locationmixed

A DocumentQuery, SpreadsheetEntry, or a string URI

Returns
TypeDescription
\Zend_Gdata_Spreadsheets_WorksheetFeedThe feed of worksheets
methodpublicimport(string $uri, \Zend_Http_Client $client = null, string $className = 'Zend_Gdata_Feed') : string | \Zend_Gdata_App_Feed
staticinherited

Imports a feed located at $uri.

Inherited from: \Zend_Gdata::import()
Parameters
NameTypeDescription
$uristring
$client\Zend_Http_Client

The client used for communication

$classNamestring

The class which is used as the return type

Returns
TypeDescription
string | \Zend_Gdata_App_FeedReturns string only if the object mapping has been disabled explicitly by passing false to the useObjectMapping() function.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
methodpublicimportFile(string $filename, string $className = 'Zend_Gdata_App_Feed', string $useIncludePath = false) : \Zend_Gdata_App_Feed
staticinherited

Imports a feed from a file located at $filename.

Inherited from: \Zend_Gdata_App::importFile()\Zend_Gdata::importFile()
Parameters
NameTypeDescription
$filenamestring
$classNamestring

The class which is used as the return type

$useIncludePathstring

Whether the include_path should be searched

Returns
TypeDescription
\Zend_Gdata_App_Feed
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
methodpublicimportString(string $string, string $className = 'Zend_Gdata_App_Feed',  $majorProtocolVersion = null,  $minorProtocolVersion = null) : \Zend_Gdata_App_Feed
staticinherited

Imports a feed represented by $string.

Inherited from: \Zend_Gdata_App::importString()\Zend_Gdata::importString()
Parameters
NameTypeDescription
$stringstring
$classNamestring

The class which is used as the return type

$majorProtocolVersion
$minorProtocolVersion
Returns
TypeDescription
\Zend_Gdata_App_Feed
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
methodpublicimportUrl(string $url, string $className = 'Zend_Gdata_App_Feed', array $extraHeaders = array()) : string | \Zend_Gdata_App_Feed
inherited

Imports the specified URL (non-statically).

Inherited from: \Zend_Gdata_App::importUrl()\Zend_Gdata::importUrl()
Parameters
NameTypeDescription
$urlstring

The URL to import

$classNamestring

The class which is used as the return type

$extraHeadersarray

Extra headers to add to the request, as an array of string-based key/value pairs.

Returns
TypeDescription
string | \Zend_Gdata_App_FeedReturns string only if the object mapping has been disabled explicitly by passing false to the useObjectMapping() function.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
methodpublicinsertEntry(mixed $data, string $uri, string $className = 'Zend_Gdata_App_Entry', array $extraHeaders = array()) : \Zend_Gdata_App_Entry
inherited

Inserts an entry to a given URI and returns the response as a fully formed Entry.

Inherited from: \Zend_Gdata_App::insertEntry()\Zend_Gdata::insertEntry()
Parameters
NameTypeDescription
$datamixed

The Zend_Gdata_App_Entry or XML to post

$uristring

POST URI

$classNamestring

The class of entry to be returned.

$extraHeadersarray

Extra headers to add to the request, as an array of string-based key/value pairs.

Returns
TypeDescription
\Zend_Gdata_App_EntryThe entry returned by the service after insertion.
methodpublicinsertRow(array $rowData, string $key, string $wkshtId = 'default') : \ListEntry

Inserts a new row with provided data.

Parameters
NameTypeDescription
$rowDataarray

An array of column header to row data

$keystring

The key of the spreadsheet to modify

$wkshtIdstring

(optional) The worksheet to modify

Returns
TypeDescription
\ListEntryThe inserted row
methodpublicisAuthenticated() : boolean
inherited

Determines whether service object is authenticated.

Inherited from: \Zend_Gdata::isAuthenticated()
Returns
TypeDescription
booleanTrue if service object is authenticated, false otherwise.
methodpublicperformHttpRequest(string $method, string $url, array $headers = array(), string $body = null, string $contentType = null, int $remainingRedirects = null) : \Zend_Http_Response
inherited

Performs a HTTP request using the specified method.

Inherited from: \Zend_Gdata::performHttpRequest()

Overrides the definition in the parent (Zend_Gdata_App) and uses the Zend_Gdata_HttpClient functionality to filter the HTTP requests and responses.

Parameters
NameTypeDescription
$methodstring

The HTTP method for the request - 'GET', 'POST', 'PUT', 'DELETE'

$urlstring

The URL to which this request is being performed, or null if found in $data

$headersarray

An associative array of HTTP headers for this request

$bodystring

The body of the HTTP request

$contentTypestring

The value for the content type of the request body

$remainingRedirectsint

Number of redirects to follow if requests results in one

Returns
TypeDescription
\Zend_Http_ResponseThe response object
methodpublicpost(mixed $data, string $uri = null,  $remainingRedirects = null, string $contentType = null, array $extraHeaders = null) : \Zend_Http_Response
inherited

POST data with client object

Inherited from: \Zend_Gdata_App::post()\Zend_Gdata::post()
Parameters
NameTypeDescription
$datamixed

The Zend_Gdata_App_Entry or XML to post

$uristring

POST URI

$remainingRedirects
$contentTypestring

Content-type of the data

$extraHeadersarray

Extra headers to add to the request, as an array of string-based key/value pairs.

Returns
TypeDescription
\Zend_Http_Response
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_App_InvalidArgumentException
methodpublicprepareRequest(string $method, string $url = null, array $headers = array(), mixed $data = null, string $contentTypeOverride = null) : array
inherited

Provides pre-processing for HTTP requests to APP services.

Inherited from: \Zend_Gdata_App::prepareRequest()\Zend_Gdata::prepareRequest()
  1. Checks the $data element and, if it's an entry, extracts the XML, multipart data, edit link (PUT,DELETE), etc.
  2. If $data is a string, sets the default content-type header as 'application/atom+xml' if it's not already been set.
  3. Adds a x-http-method override header and changes the HTTP method to 'POST' if necessary as per getHttpMethodOverride()
Parameters
NameTypeDescription
$methodstring

The HTTP method for the request - 'GET', 'POST', 'PUT', 'DELETE'

$urlstring

The URL to which this request is being performed, or null if found in $data

$headersarray

An associative array of HTTP headers for this request

$datamixed

The Zend_Gdata_App_Entry or XML for the body of the request

$contentTypeOverridestring

The override value for the content type of the request body

Returns
TypeDescription
arrayAn associative array containing the determined 'method', 'url', 'data', 'headers', 'contentType'
methodpublicput(mixed $data, string $uri = null,  $remainingRedirects = null, string $contentType = null, array $extraHeaders = null) : \Zend_Http_Response
inherited

PUT data with client object

Inherited from: \Zend_Gdata_App::put()\Zend_Gdata::put()
Parameters
NameTypeDescription
$datamixed

The Zend_Gdata_App_Entry or XML to post

$uristring

PUT URI

$remainingRedirects
$contentTypestring

Content-type of the data

$extraHeadersarray

Extra headers to add to the request, as an array of string-based key/value pairs.

Returns
TypeDescription
\Zend_Http_Response
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_App_InvalidArgumentException
methodpublicregisterPackage(string $name) : void
inherited

Adds a Zend Framework package to the $_registeredPackages array.

Inherited from: \Zend_Gdata_App::registerPackage()\Zend_Gdata::registerPackage()

This array is searched when using the magic __call method below to instantiante new objects.

Parameters
NameTypeDescription
$namestring

The name of the package (eg Zend_Gdata_App)

methodpublicretrieveAllEntriesForFeed(object $feed) : mixed
inherited

Retrieve all entries for a feed, iterating through pages as necessary.

Inherited from: \Zend_Gdata_App::retrieveAllEntriesForFeed()\Zend_Gdata::retrieveAllEntriesForFeed()

Be aware that calling this function on a large dataset will take a significant amount of time to complete. In some cases this may cause execution to timeout without proper precautions in place.

Parameters
NameTypeDescription
$feedobject

The feed to iterate through.

Returns
TypeDescription
mixedA new feed of the same type as the one originally passed in, containing all relevent entries.
methodpublicsetGzipEnabled(boolean $enabled = false) : void
staticinherited

Toggle requesting gzip encoded responses

Inherited from: \Zend_Gdata_App::setGzipEnabled()\Zend_Gdata::setGzipEnabled()
Parameters
NameTypeDescription
$enabledboolean

Whether or not to enable gzipped responses

methodpublicsetHttpClient(\Zend_Http_Client $client,  $applicationId = 'MyCompany-MyApp-1.0') : \Zend_Gdata_App
inherited

Set the Zend_Http_Client object used for communication

Inherited from: \Zend_Gdata_App::setHttpClient()\Zend_Gdata::setHttpClient()
Parameters
NameTypeDescription
$client\Zend_Http_Client

The client to use for communication

$applicationId
Returns
TypeDescription
\Zend_Gdata_AppProvides a fluent interface
Throws
ExceptionDescription
\Zend_Gdata_App_HttpException
methodpublicsetHttpMethodOverride(boolean $override = true) : void
staticinherited

Toggle using POST instead of PUT and DELETE HTTP methods

Inherited from: \Zend_Gdata_App::setHttpMethodOverride()\Zend_Gdata::setHttpMethodOverride()

Some feed implementations do not accept PUT and DELETE HTTP methods, or they can't be used because of proxies or other measures. This allows turning on using POST where PUT and DELETE would normally be used; in addition, an X-Method-Override header will be sent with a value of PUT or DELETE as appropriate.

Parameters
NameTypeDescription
$overrideboolean

Whether to override PUT and DELETE with POST.

methodpublicsetMajorProtocolVersion(int $value) : void
inherited

Set the major protocol version that should be used.

Inherited from: \Zend_Gdata_App::setMajorProtocolVersion()\Zend_Gdata::setMajorProtocolVersion()

Values < 1 will cause a Zend_Gdata_App_InvalidArgumentException to be thrown.

Parameters
NameTypeDescription
$valueint

The major protocol version to use.

Throws
ExceptionDescription
\Zend_Gdata_App_InvalidArgumentException
Details
See
\_majorProtocolVersion  
methodpublicsetMaxRedirects(int $maxRedirects) : void
staticinherited

Set the maximum number of redirects to follow during HTTP operations

Inherited from: \Zend_Gdata_App::setMaxRedirects()\Zend_Gdata::setMaxRedirects()
Parameters
NameTypeDescription
$maxRedirectsint

Maximum number of redirects to follow

methodpublicsetMinorProtocolVersion(\(int | \NULL) $value) : void
inherited

Set the minor protocol version that should be used.

Inherited from: \Zend_Gdata_App::setMinorProtocolVersion()\Zend_Gdata::setMinorProtocolVersion()

If set to NULL, no minor protocol version will be sent to the server. Values < 0 will cause a Zend_Gdata_App_InvalidArgumentException to be thrown.

Parameters
NameTypeDescription
$value\(int | \NULL)

The minor protocol version to use.

Throws
ExceptionDescription
\Zend_Gdata_App_InvalidArgumentException
Details
See
\_minorProtocolVersion  
methodpublicsetStaticHttpClient(\Zend_Http_Client $httpClient) : void
staticinherited

Set the static HTTP client instance

Inherited from: \Zend_Gdata_App::setStaticHttpClient()\Zend_Gdata::setStaticHttpClient()

Sets the static HTTP client object to use for retrieving the feed.

Parameters
NameTypeDescription
$httpClient\Zend_Http_Client
methodpublicsetVerboseExceptionMessages(boolean $verbose) : void
staticinherited

Set whether to use verbose exception messages

Inherited from: \Zend_Gdata_App::setVerboseExceptionMessages()\Zend_Gdata::setVerboseExceptionMessages()

In the case of HTTP errors, use the body of the HTTP response in the exception message.

Parameters
NameTypeDescription
$verboseboolean

Whether to use verbose exception messages

methodpublicupdateCell(int $row, int $col, int $inputValue, string $key, string $wkshtId = 'default') : \CellEntry

Updates an existing cell.

Parameters
NameTypeDescription
$rowint

The row containing the cell to update

$colint

The column containing the cell to update

$inputValueint

The new value for the cell

$keystring

The key for the spreadsheet to be updated

$wkshtIdstring

(optional) The worksheet to be updated

Returns
TypeDescription
\CellEntryThe updated cell entry.
methodpublicupdateEntry(mixed $data, string | null $uri = null, string | null $className = null, array $extraHeaders = array()) : \Zend_Gdata_App_Entry
inherited

Update an entry

Inherited from: \Zend_Gdata_App::updateEntry()\Zend_Gdata::updateEntry()
Parameters
NameTypeDescription
$datamixed

Zend_Gdata_App_Entry or XML (w/ID and link rel='edit')

$uristring | null

The URI to send requests to, or null if $data contains the URI.

$classNamestring | null

The name of the class that should be deserialized from the server response. If null, then 'Zend_Gdata_App_Entry' will be used.

$extraHeadersarray

Extra headers to add to the request, as an array of string-based key/value pairs.

Returns
TypeDescription
\Zend_Gdata_App_EntryThe entry returned from the server
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
methodpublicupdateRow(\ListEntry $entry, array $newRowData) : void

Updates an existing row with provided data.

Parameters
NameTypeDescription
$entry\ListEntry

The row entry to update

$newRowDataarray

An array of column header to row data

methodpublicuseObjectMapping(boolean $value) : void
inherited

Enable/disable the use of XML to object mapping.

Inherited from: \Zend_Gdata_App::useObjectMapping()\Zend_Gdata::useObjectMapping()
Parameters
NameTypeDescription
$valueboolean

Pass in true to use the XML to object mapping. Pass in false or null to disable it.

methodpublicusingObjectMapping() : boolean
inherited

Determine whether service object is using XML to object mapping.

Inherited from: \Zend_Gdata_App::usingObjectMapping()\Zend_Gdata::usingObjectMapping()
Returns
TypeDescription
booleanTrue if service object is using XML to object mapping, false otherwise.
Documentation was generated by phpDocumentor 2.0.0a12.