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-2010 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 44)

Zend_Gdata_App
   |
   --Zend_Gdata

Direct descendents

Class	Description
Zend_Gdata_Books	Service class for interacting with the Books service
Zend_Gdata_Health	Service class for interacting with the Google Health Data API
Zend_Gdata_Exif	Service class for interacting with the services which use the EXIF extensions
Zend_Gdata_Spreadsheets	Gdata Spreadsheets
Zend_Gdata_Geo	Service class for interacting with the services which use the GeoRSS + GML extensions.
Zend_Gdata_DublinCore	Service class for interacting with the services which use the DublinCore extensions.
Zend_Gdata_Media	Service class for interacting with the services which use the media extensions
Zend_Gdata_Docs	Service class for interacting with the Google Document List data API
Zend_Gdata_Gbase	Service class for interacting with the Google Base data API
Zend_Gdata_Calendar	Service class for interacting with the Google Calendar data API
Zend_Gdata_Gapps	Service class for interacting with the Google Apps Provisioning API.
Zend_Gdata_Photos	Service class for interacting with the Google Photos 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 string|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'])

string|Zend_Gdata_App_Entry getEntry (mixed $location, [ $className = 'Zend_Gdata_Entry'])

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

boolean isAuthenticated ()

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

Namespaces used for Gdata data

access: public

Redefined in descendants as:

Zend_Gdata_Books::$namespaces : Namespaces used for Zend_Gdata_Books
Zend_Gdata_Health::$namespaces
Zend_Gdata_Exif::$namespaces : Namespaces used for Zend_Gdata_Exif
Zend_Gdata_Spreadsheets::$namespaces : Namespaces used for Zend_Gdata_Photos
Zend_Gdata_Geo::$namespaces : Namespaces used for Zend_Gdata_Geo
Zend_Gdata_DublinCore::$namespaces : Namespaces used for Zend_Gdata_DublinCore
Zend_Gdata_Media::$namespaces : Namespaces used for Zend_Gdata_Photos
Zend_Gdata_YouTube::$namespaces : Namespaces used for Zend_Gdata_YouTube
Zend_Gdata_Gbase::$namespaces : Namespaces used for Zend_Gdata_Gbase
Zend_Gdata_Calendar::$namespaces : Namespaces used for Zend_Gdata_Calendar
Zend_Gdata_Gapps::$namespaces : Namespaces used for Zend_Gdata_Gapps
Zend_Gdata_Photos::$namespaces : Namespaces used for Zend_Gdata_Photos

static Zend_Gdata_HttpClient $_staticHttpClient = null (line 97)

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

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_Docs::$_defaultPostUri
Zend_Gdata_Gbase::$_defaultPostUri : The default URI for POST methods
Zend_Gdata_Calendar::$_defaultPostUri

Zend_Gdata_HttpClient $_httpClient (line 90)

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

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::$_majorProtocolVersion
Zend_Gdata_App::$_maxRedirects
Zend_Gdata_App::$_minorProtocolVersion
Zend_Gdata_App::$_useObjectMapping
Zend_Gdata_App::$_verboseExceptionMessages

Methods

static import (line 123)

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

static string|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 106)

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_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

getEntry (line 175)

Retrieve entry as string or object

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

string|Zend_Gdata_App_Entry getEntry (mixed $location, [ $className = 'Zend_Gdata_Entry'])

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

Redefinition of:

Zend_Gdata_App::getEntry(): Retrieve entry as string or object

getFeed (line 150)

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.
throws: Zend_Gdata_App_InvalidArgumentException
access: public

string|Zend_Gdata_App_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(): Retrieve feed as string or object

isAuthenticated (line 230)

Determines whether service object is authenticated.

return: True if service object is authenticated, false otherwise.
access: public

boolean isAuthenticated ()

performHttpRequest (line 210)

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::generateIfMatchHeaderData()
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::getMajorProtocolVersion()
Zend_Gdata_App::getMaxRedirects()
Zend_Gdata_App::getMinorProtocolVersion()
Zend_Gdata_App::getNextFeed()
Zend_Gdata_App::getPreviousFeed()
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::setMajorProtocolVersion()
Zend_Gdata_App::setMaxRedirects()
Zend_Gdata_App::setMinorProtocolVersion()
Zend_Gdata_App::setStaticHttpClient()
Zend_Gdata_App::setVerboseExceptionMessages()
Zend_Gdata_App::updateEntry()
Zend_Gdata_App::useObjectMapping()
Zend_Gdata_App::usingObjectMapping()
Zend_Gdata_App::__call()

Class Constants

AUTH_SERVICE_NAME = 'xapi' (line 52)

Service name for use with Google's authentication mechanisms

Inherited Constants

Inherited from Zend_Gdata_App

Zend_Gdata_App::DEFAULT_MAJOR_PROTOCOL_VERSION
Zend_Gdata_App::DEFAULT_MINOR_PROTOCOL_VERSION