Docs For Class Zend

Description

Provides functionality to interact with Google data APIs Subclasses exist to implement service-specific features

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

copyright: Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
link: http://code.google.com/apis/gdata/overview.html
license: New BSD License

Located in /Gdata.php (line 41)

Zend_Gdata_App
   |
   --Zend_Gdata

Direct descendents

Class	Description
Zend_Gdata_Media	Service class for interacting with the services which use the media extensions
Zend_Gdata_Geo	Service class for interacting with the services which use the GeoRSS + GML extensions.
Zend_Gdata_Photos	Service class for interacting with the Google Photos Data API.
Zend_Gdata_Gbase	Service class for interacting with the Google Base data API
Zend_Gdata_Exif	Service class for interacting with the services which use the EXIF extensions
Zend_Gdata_Spreadsheets	Gdata Spreadsheets
Zend_Gdata_Gapps	Service class for interacting with the Google Apps Provisioning API.
Zend_Gdata_Docs	Service class for interacting with the Google Document List data API
Zend_Gdata_Calendar	Service class for interacting with the Google Calendar data API

Class Constant Summary

AUTH_SERVICE_NAME = 'xapi'

Variable Summary

static array $namespaces

static Zend_Gdata_HttpClient $_staticHttpClient

string $_defaultPostUri

Zend_Gdata_HttpClient $_httpClient

array $_registeredPackages

Method Summary

static Zend_Gdata_App_Feed import (string $uri, [Zend_Http_Client $client = null], [string $className = 'Zend_Gdata_Feed'])

Zend_Gdata __construct ([Zend_Http_Client $client = null], [string $applicationId = 'MyCompany-MyApp-1.0'])

Zend_Gdata_Feed getEntry (mixed $location, [ $className = 'Zend_Gdata_Entry'])

Zend_Gdata_Feed getFeed (mixed $location, [string $className = 'Zend_Gdata_Feed'])

Zend_Http_Response performHttpRequest (string $method, string $url, [array $headers = array()], [string $body = null], [string $contentType = null], [int $remainingRedirects = null])

Variables

static array $namespaces = array(
'openSearch' => 'http://a9.com/-/spec/opensearchrss/1.0/',
'rss' => 'http://blogs.law.harvard.edu/tech/rss',
'gd' => 'http://schemas.google.com/g/2005') (line 75)

Namespaces used for GData data

access: public

Redefined in descendants as:

static Zend_Gdata_HttpClient $_staticHttpClient = null (line 92)

Client object used to communicate in static context

access: protected

Redefinition of:

Zend_Gdata_App::$_staticHttpClient: Client object used to communicate in static context

string $_defaultPostUri = null (line 56)

Default URI to which to POST.

access: protected

Redefinition of:

Zend_Gdata_App::$_defaultPostUri: Default URI to which to POST.

Redefined in descendants as:

Zend_Gdata_Gbase::$_defaultPostUri : The default URI for POST methods
Zend_Gdata_Docs::$_defaultPostUri
Zend_Gdata_Calendar::$_defaultPostUri

Zend_Gdata_HttpClient $_httpClient (line 85)

Client object used to communicate

access: protected

Redefinition of:

Zend_Gdata_App::$_httpClient: Client object used to communicate

array $_registeredPackages = array(
'Zend_Gdata_Kind',
'Zend_Gdata_Extension',
'Zend_Gdata',
'Zend_Gdata_App_Extension',
'Zend_Gdata_App') (line 63)

Packages to search for classes when using magic __call method, in order.

access: protected

Redefinition of:

Zend_Gdata_App::$_registeredPackages: Packages to search for classes when using magic __call method, in order.

Inherited Variables

Inherited from Zend_Gdata_App

Zend_Gdata_App::$_gzipEnabled
Zend_Gdata_App::$_httpMethodOverride
Zend_Gdata_App::$_maxRedirects
Zend_Gdata_App::$_verboseExceptionMessages

Methods

static import (line 114)

Imports a feed located at $uri.

throws: Zend_Gdata_App_Exception
access: public

static Zend_Gdata_App_Feed import (string $uri, [Zend_Http_Client $client = null], [string $className = 'Zend_Gdata_Feed'])

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

Redefinition of:

Zend_Gdata_App::import(): Imports a feed located at $uri.

Redefined in descendants as:

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

Constructor __construct (line 100)

Create Gdata object

access: public

Zend_Gdata __construct ([Zend_Http_Client $client = null], [string $applicationId = 'MyCompany-MyApp-1.0'])

Zend_Http_Client $client
string $applicationId: The identity of the app in the form of Company-AppName-Version

Redefinition of:

Zend_Gdata_App::__construct(): Create Gdata object

Redefined in descendants as:

Zend_Gdata_Media::__construct() : Create Gdata_Media object
Zend_Gdata_YouTube::__construct() : Create Zend_Gdata_YouTube object
Zend_Gdata_Geo::__construct() : Create Zend_Gdata_Geo object
Zend_Gdata_Photos::__construct() : Create Zend_Gdata_Photos object
Zend_Gdata_Gbase::__construct() : Create Zend_Gdata_Gbase object
Zend_Gdata_Exif::__construct() : Create Zend_Gdata_Exif object
Zend_Gdata_Spreadsheets::__construct() : Create Gdata_Spreadsheets object
Zend_Gdata_Gapps::__construct() : Create Gdata_Gapps object
Zend_Gdata_Docs::__construct() : Create Gdata_Docs object
Zend_Gdata_Calendar::__construct() : Create Gdata_Calendar object

getEntry (line 157)

Retreive entry object

access: public

Zend_Gdata_Feed getEntry (mixed $location, [ $className = 'Zend_Gdata_Entry'])

mixed $location: The location as string or Zend_Gdata_Query
$className

Redefinition of:

Zend_Gdata_App::getEntry(): Retreive entry object

getFeed (line 136)

Retreive feed object

throws: Zend_Gdata_App_InvalidArgumentException
access: public

Zend_Gdata_Feed getFeed (mixed $location, [string $className = 'Zend_Gdata_Feed'])

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

Redefinition of:

Zend_Gdata_App::getFeed(): Retreive feed object

performHttpRequest (line 192)

Performs a HTTP request using the specified method.

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

return: The response object
access: public

Zend_Http_Response performHttpRequest (string $method, string $url, [array $headers = array()], [string $body = null], [string $contentType = null], [int $remainingRedirects = null])

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
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 requests results in one

Redefinition of:

Zend_Gdata_App::performHttpRequest(): Performs a HTTP request using the specified method

Inherited Methods

Inherited From Zend_Gdata_App

Zend_Gdata_App::__construct()
Zend_Gdata_App::delete()
Zend_Gdata_App::enableRequestDebugLogging()
Zend_Gdata_App::get()
Zend_Gdata_App::getEntry()
Zend_Gdata_App::getFeed()
Zend_Gdata_App::getGzipEnabled()
Zend_Gdata_App::getHttpClient()
Zend_Gdata_App::getHttpMethodOverride()
Zend_Gdata_App::getMaxRedirects()
Zend_Gdata_App::getStaticHttpClient()
Zend_Gdata_App::getVerboseExceptionMessages()
Zend_Gdata_App::import()
Zend_Gdata_App::importFile()
Zend_Gdata_App::importString()
Zend_Gdata_App::importUrl()
Zend_Gdata_App::insertEntry()
Zend_Gdata_App::performHttpRequest()
Zend_Gdata_App::post()
Zend_Gdata_App::prepareRequest()
Zend_Gdata_App::put()
Zend_Gdata_App::registerPackage()
Zend_Gdata_App::retrieveAllEntriesForFeed()
Zend_Gdata_App::setGzipEnabled()
Zend_Gdata_App::setHttpClient()
Zend_Gdata_App::setHttpMethodOverride()
Zend_Gdata_App::setMaxRedirects()
Zend_Gdata_App::setStaticHttpClient()
Zend_Gdata_App::setVerboseExceptionMessages()
Zend_Gdata_App::updateEntry()
Zend_Gdata_App::__call()

Class Constants

AUTH_SERVICE_NAME = 'xapi' (line 49)

Service name for use with Google's authentication mechanisms