static boolean $_gzipEnabled = false (line 96)

Enable gzipped responses?

• access: protected

static int $_maxRedirects = 5 (line 127)

Maximum number of redirects to follow during HTTP operations

• access: protected

static boolean $_verboseExceptionMessages = true (line 104)

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

• access: protected

Zend_Http_Client $_httpClient (line 75)

Client object used to communicate

• access: protected

• Zend_Gdata::$_httpClient : Client object used to communicate

mixed $_minorProtocolVersion (line 156)

Indicates the minor protocol version that should be used. 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.

• see: Zend_Gdata_App::setMinorProtocolVersion()
• see: Zend_Gdata_App::getMinorProtocolVersion()
• access: protected

boolean $_useObjectMapping = true (line 163)

Whether we want to use XML to object mapping when fetching data.

• access: protected

static getHttpMethodOverride (line 320)

Get the HTTP override state

• access: public

static getStaticHttpClient (line 282)

Gets the HTTP client object. If none is set, a new Zend_Http_Client will be used.

• access: public

static import (line 719)

Imports a feed located at $uri.

• return: Returns string only if the object mapping has been disabled explicitly by passing false to the useObjectMapping() function.
• throws: Zend_Gdata_App_Exception
• access: public

• string $uri
• Zend_Http_Client $client: The client used for communication
• string $className: The class which is used as the return type

• Zend_Gdata::import() : Imports a feed located at $uri.
• Zend_Gdata_Gapps::import() : Imports a feed located at $uri.

static importString (line 799)

Imports a feed represented by $string.

• throws: Zend_Gdata_App_Exception
• access: public

• string $string
• string $className: The class which is used as the return type
• integer $majorProcolVersion: (optional) The major protocol version of the data model object that is to be created.
• integer $minorProcolVersion: (optional) The minor protocol version of the data model object that is to be created.
• $majorProtocolVersion
• $minorProtocolVersion

static setHttpMethodOverride (line 310)

Toggle using POST instead of PUT and DELETE HTTP methods

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.

• access: public

• boolean $override: Whether to override PUT and DELETE with POST.

static setStaticHttpClient (line 271)

Set the static HTTP client instance

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

• access: public

• Zend_Http_Client $httpClient

Constructor __construct (line 171)

Create Gdata object

• access: public

• Zend_Http_Client $client
• string $applicationId

• Zend_Gdata::__construct() : Create Gdata object
• Zend_Gdata_Books::__construct() : Create Zend_Gdata_Books object
• Zend_Gdata_Health::__construct() : Create Zend_Gdata_Health object
• Zend_Gdata_Exif::__construct() : Create Zend_Gdata_Exif object
• Zend_Gdata_Spreadsheets::__construct() : Create Gdata_Spreadsheets object
• Zend_Gdata_Geo::__construct() : Create Zend_Gdata_Geo object
• Zend_Gdata_DublinCore::__construct() : Create Zend_Gdata_DublinCore object
• Zend_Gdata_Media::__construct() : Create Gdata_Media object
• Zend_Gdata_YouTube::__construct() : Create Zend_Gdata_YouTube object
• Zend_Gdata_Docs::__construct() : Create Gdata_Docs object
• Zend_Gdata_Gbase::__construct() : Create Zend_Gdata_Gbase object
• Zend_Gdata_Calendar::__construct() : Create Gdata_Calendar object
• Zend_Gdata_Gapps::__construct() : Create Gdata_Gapps object
• Zend_Gdata_Photos::__construct() : Create Zend_Gdata_Photos object

enableRequestDebugLogging (line 1098)

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

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

• access: public

• $logfile $logfile: The logfile to use when logging the requests

get (line 856)

GET a URI using client object.

• throws: Zend_Gdata_App_HttpException
• access: public

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

• Zend_Gdata_Gapps::get() : GET a URI using client object.

getFeed (line 203)

Retrieve feed as string or object

• return: Returns string only if the object mapping has been disabled explicitly by passing false to the useObjectMapping() function.
• access: public

• string $uri: The uri from which to retrieve the feed
• string $className: The class which is used as the return type

• Zend_Gdata::getFeed() : Retrieve feed as string or object

getMajorProtocolVersion (line 424)

Get the major protocol version that is in use.

• return: The major protocol version in use.
• see: Zend_Gdata_App::$_majorProtocolVersion
• access: public

getNextFeed (line 1118)

Retrieve next set of results based on a given feed.

• return: Returns a Zend_Gdata_App_Feed or null if no next set of results exists.
• access: public

• Zend_Gdata_App_Feed $feed: The feed from which to retreive the next set of results.
• string $className: (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.

importUrl (line 751)

Imports the specified URL (non-statically).

• return: Returns string only if the object mapping has been disabled explicitly by passing false to the useObjectMapping() function.
• throws: Zend_Gdata_App_Exception
• access: public

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

performHttpRequest (line 589)

Performs a HTTP request using the specified method

• return: The response object
• access: public

• string $method: The HTTP method for the request - 'GET', 'POST', 'PUT', 'DELETE'
• string $url: The URL to which this request is being performed
• array $headers: An associative array of HTTP headers for this request
• string $body: The body of the HTTP request
• string $contentType: The value for the content type of the request body
• int $remainingRedirects: Number of redirects to follow if request s results in one

• Zend_Gdata::performHttpRequest() : Performs a HTTP request using the specified method.

prepareRequest (line 483)

Provides pre-processing for HTTP requests to APP services.

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

• return: An associative array containing the determined 'method', 'url', 'data', 'headers', 'contentType'
• access: public

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

registerPackage (line 188)

Adds a Zend Framework package to the $_registeredPackages array.

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

• access: public

• string $name: The name of the package (eg Zend_Gdata_App)

setHttpClient (line 240)

Set the Zend_Http_Client object used for communication

• return: Provides a fluent interface
• throws: Zend_Gdata_App_HttpException
• access: public

• Zend_Http_Client $client: The client to use for communication
• $applicationId

• Zend_Gdata_YouTube::setHttpClient() : Set the Zend_Http_Client object used for communication

setMinorProtocolVersion (line 438)

Set the minor protocol version that should be used. 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.

• see: Zend_Gdata_App::$_minorProtocolVersion
• throws: Zend_Gdata_App_InvalidArgumentException
• access: public

• (int|NULL) $value: The minor protocol version to use.

useObjectMapping (line 1202)

Enable/disable the use of XML to object mapping.

• access: public

• boolean $value: Pass in true to use the XML to object mapping. Pass in false or null to disable it.

__call (line 1017)

Provides a magic factory method to instantiate new objects with

shorter syntax than would otherwise be required by the Zend Framework naming conventions. 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

• throws: Zend_Gdata_App_Exception
• access: public

• string $method: The method name being called
• array $args: The arguments passed to the call

• Zend_Gdata_Gapps::__call() : Provides a magic factory method to instantiate new objects with shorter syntax than would otherwise be required by the Zend Framework naming conventions. For more information, see Zend_Gdata_App::__call().

DEFAULT_MINOR_PROTOCOL_VERSION = null (line 68)

Default minor protocol version.

• see: Zend_Gdata_App::$_minorProtocolVersion