Gdata/Docs.php

+ Show: +

inherited

+ Classes +
- \Zend_Gdata_Docs

+ 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: Docs + +
Version: $Id: Docs.php 24593 2012-01-05 20:35:02Z matthew $ + +

\Zend_Gdata_Docs
jump to top

Package: Zend\Gdata\Docs

Service class for interacting with the Google Document List data API

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/documents/ + +

Constants

 
+                DOCUMENTS_LIST_FEED_URI
+                = 'https://docs.google.com/feeds/documents/private/full'

 
+                DOCUMENTS_FOLDER_FEED_URI
+                = 'https://docs.google.com/feeds/folders/private/full'

 
+                DOCUMENTS_CATEGORY_SCHEMA
+                = 'http://schemas.google.com/g/2005#kind'

 
+                DOCUMENTS_CATEGORY_TERM
+                = 'http://schemas.google.com/docs/2007#folder'

string 
+                AUTH_SERVICE_NAME
+                = 'writely'

Service name for use with Google's authentication mechanisms

: string

 
+                DEFAULT_MAJOR_PROTOCOL_VERSION
+                = 1

inherited

Default major protocol version.

Inherited from: + \Zend_Gdata_App::DEFAULT_MAJOR_PROTOCOL_VERSION \Zend_Gdata::DEFAULT_MAJOR_PROTOCOL_VERSION

Inherited_from: \Zend_Gdata_App::DEFAULT_MAJOR_PROTOCOL_VERSION + +
Inherited_from: \Zend_Gdata::DEFAULT_MAJOR_PROTOCOL_VERSION + +
See: \_majorProtocolVersion + +

 
+                DEFAULT_MINOR_PROTOCOL_VERSION
+                = null

inherited

Default minor protocol version.

Inherited from: + \Zend_Gdata_App::DEFAULT_MINOR_PROTOCOL_VERSION \Zend_Gdata::DEFAULT_MINOR_PROTOCOL_VERSION

Inherited_from: \Zend_Gdata_App::DEFAULT_MINOR_PROTOCOL_VERSION + +
Inherited_from: \Zend_Gdata::DEFAULT_MINOR_PROTOCOL_VERSION + +
See: \_minorProtocolVersion + +

Properties

$SUPPORTED_FILETYPES = array('TXT' => 'text/plain', 'CSV' => 'text/csv', 'TSV' => 'text/tab-separated-values', 'TAB' => 'text/tab-separated-values', 'HTML' => 'text/html', 'HTM' => 'text/html', 'DOC' => 'application/msword', 'ODS' => 'application/vnd.oasis.opendocument.spreadsheet', 'ODT' => 'application/vnd.oasis.opendocument.text', 'RTF' => 'application/rtf', 'SXW' => 'application/vnd.sun.xml.writer', 'XLS' => 'application/vnd.ms-excel', 'XLSX' => 'application/vnd.ms-excel', 'PPT' => 'application/vnd.ms-powerpoint', 'PPS' => 'application/vnd.ms-powerpoint')

static

Default value

array('TXT' => 'text/plain', 'CSV' => 'text/csv', 'TSV' => 'text/tab-separated-values', 'TAB' => 'text/tab-separated-values', 'HTML' => 'text/html', 'HTM' => 'text/html', 'DOC' => 'application/msword', 'ODS' => 'application/vnd.oasis.opendocument.spreadsheet', 'ODT' => 'application/vnd.oasis.opendocument.text', 'RTF' => 'application/rtf', 'SXW' => 'application/vnd.sun.xml.writer', 'XLS' => 'application/vnd.ms-excel', 'XLSX' => 'application/vnd.ms-excel', 'PPT' => 'application/vnd.ms-powerpoint', 'PPS' => 'application/vnd.ms-powerpoint')

Details

Type: n/a

string $_defaultPostUri = self::DOCUMENTS_LIST_FEED_URI

Default URI to which to POST.

Default valueself::DOCUMENTS_LIST_FEED_URIDetails

Type: string

boolean $_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 + +

\Zend_Gdata_HttpClient $_httpClient

inherited

Client object used to communicate

Inherited from: + \Zend_Gdata::$$_httpClient

Details

Type: \Zend_Gdata_HttpClient
Inherited_from: \Zend_Gdata::$$_httpClient + +

boolean $_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 + +

$_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() + +

int $_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 + +

$_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() + +

array $_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 + +

\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 + +

boolean $_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 + +

boolean $_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 + +

array $namespaces = array(array('gd', 'http://schemas.google.com/g/2005', 1, 0), array('openSearch', 'http://a9.com/-/spec/opensearchrss/1.0/', 1, 0), array('openSearch', 'http://a9.com/-/spec/opensearch/1.1/', 2, 0), array('rss', 'http://blogs.law.harvard.edu/tech/rss', 1, 0))

staticinherited

Namespaces used for Gdata data

Inherited from: + \Zend_Gdata::$$namespaces

Default value

array(array('gd', 'http://schemas.google.com/g/2005', 1, 0), array('openSearch', 'http://a9.com/-/spec/opensearchrss/1.0/', 1, 0), array('openSearch', 'http://a9.com/-/spec/opensearch/1.1/', 2, 0), array('rss', 'http://blogs.law.harvard.edu/tech/rss', 1, 0))

Details

Type: array
Inherited_from: \Zend_Gdata::$$namespaces + +

Methods

__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

Name	Type	Description
$method	string	The method name being called
$args	array	The arguments passed to the call

Throws

Exception	Description
\Zend_Gdata_App_Exception

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

Create Gdata_Docs 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 +

createFolder(string $folderName, string | null $folderResourceId = null) : \Zend_Gdata_Entry

Creates a new folder in Google Docs

Parameters

Name	Type	Description
$folderName	string	The folder name to create
$folderResourceId	string \| null	The parent folder to create it in + ("folder%3Amy_parent_folder") +

Returns

Type	Description
\Zend_Gdata_Entry	The folder entry created.

Details

Todo: ZF-8732: This should return a *subclass* of Zend_Gdata_Entry, but + the appropriate type doesn't exist yet. + +

delete(mixed $data, $remainingRedirects = null) : void

inherited

DELETE entry with client object

Inherited from: + \Zend_Gdata_App::delete()\Zend_Gdata::delete()

Parameters

Name	Type	Description
$data	mixed	The Zend_Gdata_App_Entry or URL to delete
$remainingRedirects

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_App_InvalidArgumentException

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

Name	Type	Description
$logfile	string	The logfile to use when logging the requests

generateIfMatchHeaderData( $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

Name	Type	Description
$data
$allowWeek

Returns

Type	Description
string \| null	$data

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

Name	Type	Description
$uri	string	GET URI
$extraHeaders	array	Extra headers to add to the request, as an + array of string-based key/value pairs. +

Returns

Type	Description
\Zend_Http_Response

Throws

Exception	Description
\Zend_Gdata_App_HttpException

getDoc(string $docId, string $docType) : \Zend_Gdata_Docs_DocumentListEntry

Retreive entry object representing a single document.

This method builds the URL where this item is stored using the type +and the id of the document.

Parameters

Name	Type	Description
$docId	string	The URL key for the document. Examples: + dcmg89gw_62hfjj8m, pKq0CzjiF3YmGd0AIlHKqeg
$docType	string	The type of the document as used in the Google + Document List URLs. Examples: document, spreadsheet, presentation

Returns

Type	Description
\Zend_Gdata_Docs_DocumentListEntry

getDocument(string $id) : void

Retreive entry object for the desired word processing document.

Parameters

Name	Type	Description
$id	string	The URL id for the document. Example: + dcmg89gw_62hfjj8m

getDocumentListEntry(mixed $location = null) : \Zend_Gdata_Docs_DocumentListEntry

Retreive entry object representing a single document.

Parameters

Name	Type	Description
$location	mixed	The location for the entry, as a URL or Query

Returns

Type	Description
\Zend_Gdata_Docs_DocumentListEntry

getDocumentListFeed(mixed $location = null) : \Zend_Gdata_Docs_DocumentListFeed

Retreive feed object containing entries for the user's documents.

Parameters

Name	Type	Description
$location	mixed	The location for the feed, as a URL or Query

Returns

Type	Description
\Zend_Gdata_Docs_DocumentListFeed

getEntry(mixed $location, $className = 'Zend_Gdata_Entry') : string | \Zend_Gdata_App_Entry

inherited

Retrieve entry as string or object

Inherited from: + \Zend_Gdata::getEntry()

Parameters

Name	Type	Description
$location	mixed	The location as string or Zend_Gdata_Query
$className

Returns

Type	Description
string \| \Zend_Gdata_App_Entry	Returns string only if the object + mapping has been disabled explicitly + by passing false to the + useObjectMapping() function.

Throws

Exception	Description
\Zend_Gdata_App_InvalidArgumentException

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

Name	Type	Description
$location	mixed	The location as string or Zend_Gdata_Query
$className	string	The class type to use for returning the feed

Returns

Type	Description
string \| \Zend_Gdata_App_Feed	Returns string only if the object + mapping has been disabled explicitly + by passing false to the + useObjectMapping() function.

Throws

Exception	Description
\Zend_Gdata_App_InvalidArgumentException

getGzipEnabled() : boolean

staticinherited

Get the HTTP override state

Inherited from: + \Zend_Gdata_App::getGzipEnabled()\Zend_Gdata::getGzipEnabled()

Returns

Type	Description
boolean

getHttpClient() : \Zend_Http_Client

inherited

Get the Zend_Http_Client object used for communication

Inherited from: + \Zend_Gdata_App::getHttpClient()\Zend_Gdata::getHttpClient()

Returns

Type	Description
\Zend_Http_Client

getHttpMethodOverride() : boolean

staticinherited

Get the HTTP override state

Inherited from: + \Zend_Gdata_App::getHttpMethodOverride()\Zend_Gdata::getHttpMethodOverride()

Returns

Type	Description
boolean

getMajorProtocolVersion() : int

inherited

Get the major protocol version that is in use.

Inherited from: + \Zend_Gdata_App::getMajorProtocolVersion()\Zend_Gdata::getMajorProtocolVersion()

Returns

Type	Description
int	The major protocol version in use.

Details

See: \_majorProtocolVersion + +

getMaxRedirects() : int

staticinherited

Get the maximum number of redirects to follow during HTTP operations

Inherited from: + \Zend_Gdata_App::getMaxRedirects()\Zend_Gdata::getMaxRedirects()

Returns

Type	Description
int	Maximum number of redirects to follow

getMinorProtocolVersion() : \(int | \NULL)

inherited

Get the minor protocol version that is in use.

Inherited from: + \Zend_Gdata_App::getMinorProtocolVersion()\Zend_Gdata::getMinorProtocolVersion()

Returns

Type	Description
\(int \| \NULL)	The major protocol version in use, or NULL if no + minor version is specified.

Details

See: \_minorProtocolVersion + +

getNextFeed(\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

Name	Type	Description
$feed	\Zend_Gdata_App_Feed	The feed from which to + retreive the next set of results.
$className	string	(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

Type	Description
\Zend_Gdata_App_Feed \| null	Returns a + Zend_Gdata_App_Feed or null if no next set of results + exists.

getPresentation(string $id) : void

Retreive entry object for the desired presentation.

Parameters

Name	Type	Description
$id	string	The URL id for the document. Example: + dcmg89gw_21gtrjcn

getPreviousFeed(\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

Name	Type	Description
$feed	\Zend_Gdata_App_Feed	The feed from which to + retreive the previous set of results.
$className	string	(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

Type	Description
\Zend_Gdata_App_Feed \| null	Returns a + Zend_Gdata_App_Feed or null if no previous set of results + exists.

getSpreadsheet(string $id) : void

Retreive entry object for the desired spreadsheet.

Parameters

Name	Type	Description
$id	string	The URL id for the document. Example: + pKq0CzjiF3YmGd0AIlHKqeg

getStaticHttpClient() : \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

Type	Description
\Zend_Http_Client

getVerboseExceptionMessages() : 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

Type	Description
boolean

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

Name	Type	Description
$uri	string
$client	\Zend_Http_Client	The client used for communication
$className	string	The class which is used as the return type

Returns

Type	Description
string \| \Zend_Gdata_App_Feed	Returns string only if the object + mapping has been disabled explicitly + by passing false to the + useObjectMapping() function.

Throws

Exception	Description
\Zend_Gdata_App_Exception

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

Name	Type	Description
$filename	string
$className	string	The class which is used as the return type
$useIncludePath	string	Whether the include_path should be searched

Returns

Type	Description
\Zend_Gdata_App_Feed

Throws

Exception	Description
\Zend_Gdata_App_Exception

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

Name	Type	Description
$string	string
$className	string	The class which is used as the return type
$majorProtocolVersion
$minorProtocolVersion

Returns

Type	Description
\Zend_Gdata_App_Feed

Throws

Exception	Description
\Zend_Gdata_App_Exception

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

Name	Type	Description
$url	string	The URL to import
$className	string	The class which is used as the return type
$extraHeaders	array	Extra headers to add to the request, as an + array of string-based key/value pairs. +

Returns

Type	Description
string \| \Zend_Gdata_App_Feed	Returns string only if the object + mapping has been disabled explicitly + by passing false to the + useObjectMapping() function.

Throws

Exception	Description
\Zend_Gdata_App_Exception

insertDocument(mixed $data, string $uri, string $className = 'Zend_Gdata_Docs_DocumentListEntry') : \Zend_Gdata_Docs_DocumentListEntry

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

Parameters

Name	Type	Description
$data	mixed	The Zend_Gdata_Docs_DocumentListEntry or media + source to post. If it is a DocumentListEntry, the mediaSource + should already have been set. If $data is a mediaSource, it + should have the correct slug header and mime type. +
$uri	string	POST URI
$className	string	(optional) The class of entry to be returned. + The default is a 'Zend_Gdata_Docs_DocumentListEntry'. +

Returns

Type	Description
\Zend_Gdata_Docs_DocumentListEntry	The entry returned by the + service after insertion.

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

Name	Type	Description
$data	mixed	The Zend_Gdata_App_Entry or XML to post
$uri	string	POST URI
$className	string	The class of entry to be returned.
$extraHeaders	array	Extra headers to add to the request, as an + array of string-based key/value pairs. +

Returns

Type	Description
\Zend_Gdata_App_Entry	The entry returned by the service after + insertion.

isAuthenticated() : boolean

inherited

Determines whether service object is authenticated.

Inherited from: + \Zend_Gdata::isAuthenticated()

Returns

Type	Description
boolean	True if service object is authenticated, false otherwise.

lookupMimeType(string $fileExtension) : string

static

Looks up the mime type based on the file name extension.

For example, +calling this method with 'csv' would return +'text/comma-separated-values'. The Mime type is sent as a header in +the upload HTTP POST request.

Parameters

Name	Type	Description
$fileExtension	string

Returns

Type	Description
string	The mime type to be sent to the server to tell it how the + multipart mime data should be interpreted.

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

Name	Type	Description
$method	string	The HTTP method for the request - + 'GET', 'POST', 'PUT', 'DELETE' +
$url	string	The URL to which this request is being performed, + or null if found in $data +
$headers	array	An associative array of HTTP headers + for this request
$body	string	The body of the HTTP request
$contentType	string	The value for the content type of the + request body
$remainingRedirects	int	Number of redirects to follow + if requests results in one

Returns

Type	Description
\Zend_Http_Response	The response object

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

Name	Type	Description
$data	mixed	The Zend_Gdata_App_Entry or XML to post
$uri	string	POST URI
$remainingRedirects
$contentType	string	Content-type of the data +
$extraHeaders	array	Extra headers to add to the request, as an + array of string-based key/value pairs. +

Returns

Type	Description
\Zend_Http_Response

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_App_InvalidArgumentException

prepareRequest(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()

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

Parameters

Name	Type	Description
$method	string	The HTTP method for the request - 'GET', 'POST', + 'PUT', 'DELETE' +
$url	string	The URL to which this request is being performed, + or null if found in $data +
$headers	array	An associative array of HTTP headers for this + request
$data	mixed	The Zend_Gdata_App_Entry or XML for the + body of the request
$contentTypeOverride	string	The override value for the + content type of the request body

Returns

Type	Description
array	An associative array containing the determined + 'method', 'url', 'data', 'headers', 'contentType'

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

Name	Type	Description
$data	mixed	The Zend_Gdata_App_Entry or XML to post
$uri	string	PUT URI
$remainingRedirects
$contentType	string	Content-type of the data +
$extraHeaders	array	Extra headers to add to the request, as an + array of string-based key/value pairs. +

Returns

Type	Description
\Zend_Http_Response

Throws

Exception	Description
\Zend_Gdata_App_Exception
\Zend_Gdata_App_HttpException
\Zend_Gdata_App_InvalidArgumentException

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

Name	Type	Description
$name	string	The name of the package (eg Zend_Gdata_App) +

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

Name	Type	Description
$feed	object	The feed to iterate through.

Returns

Type	Description
mixed	A new feed of the same type as the one originally + passed in, containing all relevent entries.

setGzipEnabled(boolean $enabled = false) : void

staticinherited

Toggle requesting gzip encoded responses

Inherited from: + \Zend_Gdata_App::setGzipEnabled()\Zend_Gdata::setGzipEnabled()

Parameters

Name	Type	Description
$enabled	boolean	Whether or not to enable gzipped responses

setHttpClient(\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

Name	Type	Description
$client	\Zend_Http_Client	The client to use for communication
$applicationId

Returns

Type	Description
\Zend_Gdata_App	Provides a fluent interface

Throws

Exception	Description
\Zend_Gdata_App_HttpException

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

Name	Type	Description
$override	boolean	Whether to override PUT and DELETE with POST.

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

Name	Type	Description
$value	int	The major protocol version to use.

Throws

Exception	Description
\Zend_Gdata_App_InvalidArgumentException

Details

See: \_majorProtocolVersion + +

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

Name	Type	Description
$maxRedirects	int	Maximum number of redirects to follow

setMinorProtocolVersion(\(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

Name	Type	Description
$value	\(int \| \NULL)	The minor protocol version to use.

Throws

Exception	Description
\Zend_Gdata_App_InvalidArgumentException

Details

See: \_minorProtocolVersion + +

setStaticHttpClient(\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

Name	Type	Description
$httpClient	\Zend_Http_Client

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

Name	Type	Description
$verbose	boolean	Whether to use verbose exception messages

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

Name	Type	Description
$data	mixed	Zend_Gdata_App_Entry or XML (w/ID and link rel='edit') +
$uri	string \| null	The URI to send requests to, or null if $data + contains the URI. +
$className	string \| null	The name of the class that should be deserialized + from the server response. If null, then 'Zend_Gdata_App_Entry' + will be used. +
$extraHeaders	array	Extra headers to add to the request, as an + array of string-based key/value pairs. +

Returns

Type	Description
\Zend_Gdata_App_Entry	The entry returned from the server

Throws

Exception	Description
\Zend_Gdata_App_Exception

uploadFile(string $fileLocation, string $title = null, string $mimeType = null, string $uri = null) : \Zend_Gdata_Docs_DocumentListEntry

Upload a local file to create a new Google Document entry.

Parameters

Name	Type	Description
$fileLocation	string	The full or relative path of the file to + be uploaded.
$title	string	The name that this document should have on the + server. If set, the title is used as the slug header in the + POST request. If no title is provided, the location of the + file will be used as the slug header in the request. If no + mimeType is provided, this method attempts to determine the + mime type based on the slugHeader by looking for .doc, + .csv, .txt, etc. at the end of the file name. + Example value: 'test.doc'. +
$mimeType	string	Describes the type of data which is being sent + to the server. This must be one of the accepted mime types + which are enumerated in SUPPORTED_FILETYPES.
$uri	string	(optional) The URL to which the upload should be + made. + Example: 'https://docs.google.com/feeds/documents/private/full'. +

Returns

Type	Description
\Zend_Gdata_Docs_DocumentListEntry	The entry for the newly + created Google Document.

useObjectMapping(boolean $value) : void

inherited

Enable/disable the use of XML to object mapping.

Inherited from: + \Zend_Gdata_App::useObjectMapping()\Zend_Gdata::useObjectMapping()

Parameters

Name	Type	Description
$value	boolean	Pass in true to use the XML to object mapping. + Pass in false or null to disable it.

usingObjectMapping() : boolean

inherited

Determine whether service object is using XML to object mapping.

Inherited from: + \Zend_Gdata_App::usingObjectMapping()\Zend_Gdata::usingObjectMapping()

Returns

Type	Description
boolean	True if service object is using XML to object mapping, + false otherwise.

Gdata/Docs.php

\Zend_Gdata_Docsjump to top

Constants

Properties

Methods

\Zend_Gdata_Docs
jump to top