Public Member Functions | Static Public Member Functions | Data Fields | Static Public Attributes | Protected Attributes | Static Protected Attributes

Zend_Gdata Class Reference

Public Member Functions

 __construct ($client=null, $applicationId= 'MyCompany-MyApp-1.0')
 getFeed ($location, $className='Zend_Gdata_Feed')
 getEntry ($location, $className='Zend_Gdata_Entry')
 performHttpRequest ($method, $url, $headers=array(), $body=null, $contentType=null, $remainingRedirects=null)
 isAuthenticated ()

Static Public Member Functions

static import ($uri, $client=null, $className='Zend_Gdata_Feed')

Data Fields

const AUTH_SERVICE_NAME = 'xapi'

Static Public Attributes

static $namespaces

Protected Attributes

 $_defaultPostUri = null
 $_registeredPackages
 $_httpClient

Static Protected Attributes

static $_staticHttpClient = null

Detailed Description

Definition at line 44 of file Gdata.php.


Constructor & Destructor Documentation

__construct ( client = null,
applicationId = 'MyCompany-MyApp-1.0' 
)

Create Gdata object

Parameters:
Zend_Http_Client$client
string$applicationIdThe identity of the app in the form of Company-AppName-Version

Definition at line 106 of file Gdata.php.


Member Function Documentation

getEntry ( location,
className = 'Zend_Gdata_Entry' 
)

Retrieve entry as string or object

Parameters:
mixed$locationThe location as string or Zend_Gdata_Query
Exceptions:
Zend_Gdata_App_InvalidArgumentException
Returns:
string|Zend_Gdata_App_Entry Returns string only if the object mapping has been disabled explicitly by passing false to the useObjectMapping() function.

Definition at line 175 of file Gdata.php.

getFeed ( location,
className = 'Zend_Gdata_Feed' 
)

Retrieve feed as string or object

Parameters:
mixed$locationThe location as string or Zend_Gdata_Query
string$classNameThe class type to use for returning the feed
Exceptions:
Zend_Gdata_App_InvalidArgumentException
Returns:
string|Zend_Gdata_App_Feed Returns string only if the object mapping has been disabled explicitly by passing false to the useObjectMapping() function.

Definition at line 150 of file Gdata.php.

static import ( uri,
client = null,
className = 'Zend_Gdata_Feed' 
) [static]

Imports a feed located at $uri.

Parameters:
string$uri
Zend_Http_Client$clientThe client used for communication
string$classNameThe class which is used as the return type
Exceptions:
Zend_Gdata_App_Exception
Returns:
string|Zend_Gdata_App_Feed Returns string only if the object mapping has been disabled explicitly by passing false to the useObjectMapping() function.

Definition at line 123 of file Gdata.php.

isAuthenticated (  )

Determines whether service object is authenticated.

Returns:
boolean True if service object is authenticated, false otherwise.

Definition at line 230 of file Gdata.php.

performHttpRequest ( method,
url,
headers = array(),
body = null,
contentType = null,
remainingRedirects = null 
)

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.

Parameters:
string$methodThe HTTP method for the request - 'GET', 'POST', 'PUT', 'DELETE'
string$urlThe URL to which this request is being performed, or null if found in $data
array$headersAn associative array of HTTP headers for this request
string$bodyThe body of the HTTP request
string$contentTypeThe value for the content type of the request body
int$remainingRedirectsNumber of redirects to follow if requests results in one
Returns:
Zend_Http_Response The response object

Definition at line 210 of file Gdata.php.


Field Documentation

$_registeredPackages [protected]
Initial value:
 array(
            'Zend_Gdata_Kind',
            'Zend_Gdata_Extension',
            'Zend_Gdata',
            'Zend_Gdata_App_Extension',
            'Zend_Gdata_App')

Definition at line 66 of file Gdata.php.

$namespaces [static]
Initial 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)
    )

Definition at line 78 of file Gdata.php.


The documentation for this class was generated from the following file: