Gdata.php

category: Zend
copyright: Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Gdata
subpackage: Gdata
version: $Id: Gdata.php 23775 2011-03-01 17:25:24Z ralph $
Classes: Zend_Gdata

Description

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.

Zend_Gdata
jump to top

Extends from: Zend_Gdata_App
category: Zend
copyright: Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
link: http://code.google.com/apis/gdata/overview.html
package: Zend_Gdata
subpackage: Gdata
Constants: AUTH_SERVICE_NAME
Properties: $_defaultPostUri; $_registeredPackages; $namespaces; $_httpClient; $_staticHttpClient
Methods: __construct; import; getFeed; getEntry; performHttpRequest; isAuthenticated

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

Constants

AUTH_SERVICE_NAME
jump to class

string AUTH_SERVICE_NAME = 'xapi'

Service name for use with Google's authentication mechanisms

Details

value: xapi
AUTH_SERVICE_NAME: string

Properties

$_defaultPostUri
jump to class

string $_defaultPostUri = 'null'

Default URI to which to POST.

Details

$_defaultPostUri: string
visibility: protected
default: null
final: false
static: false

$_httpClient
jump to class

Zend_Gdata_HttpClient $_httpClient = ''

Client object used to communicate

Details

$_httpClient: Zend_Gdata_HttpClient
visibility: protected
default
final: false
static: false

$_registeredPackages
jump to class

array $_registeredPackages = 'array'

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

Details

$_registeredPackages: array
visibility: protected
default: array
final: false
static: false

$_staticHttpClient
jump to class

Zend_Gdata_HttpClient $_staticHttpClient = 'null'

Client object used to communicate in static context

Details

$_staticHttpClient: Zend_Gdata_HttpClient
visibility: protected
default: null
final: false
static: true

$namespaces
jump to class

array $namespaces = 'array'

Namespaces used for Gdata data

Details

$namespaces: array
visibility: public
default: array
final: false
static: true

Methods

__construct
jump to class

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

Create Gdata object

Arguments

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

Details

visibility: public
final: false
static: false

getEntry
jump to class

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

Retrieve entry as string or object

Arguments

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

Output

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

Details

visibility: public
final: false
static: false
throws

getFeed
jump to class

getFeed(
          mixed $location, string $className
              =
              Zend_Gdata_Feed
          )
        
        :
        string|Zend_Gdata_App_Feed

Retrieve feed as string or object

Arguments

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

Output

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

Details

visibility: public
final: false
static: false
throws

import
jump to class

import(
          string $uri, Zend_Http_Client $client
              =
              null, string $className
              =
              Zend_Gdata_Feed
          )
        
        :
        string|Zend_Gdata_App_Feed

Imports a feed located at $uri.

Arguments

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

Output

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

Details

visibility: public
final: false
static: true
throws

isAuthenticated
jump to class

isAuthenticated(
          
          )
        
        :
        boolean

Determines whether service object is authenticated.

Output

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

Details

visibility: public
final: false
static: false

performHttpRequest
jump to class

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

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.

Arguments

$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

Output

Zend_Http_Response: The response object

Details

visibility: public
final: false
static: false

API Documentation

Gdata.php

Description

Zend_Gdatajump to top

Description

Constants

AUTH_SERVICE_NAMEjump to class

Details

Properties

$_defaultPostUrijump to class

Details

$_httpClientjump to class

Details

$_registeredPackagesjump to class

Details

$_staticHttpClientjump to class

Details

$namespacesjump to class

Details

Methods

__constructjump to class

Arguments

Details

getEntryjump to class

Arguments

Output

Details

getFeedjump to class

Arguments

Output

Details

importjump to class

Arguments

Output

Details

isAuthenticatedjump to class

Output

Details

performHttpRequestjump to class

Arguments

Output

Details

Zend_Gdata
jump to top

AUTH_SERVICE_NAME
jump to class

$_defaultPostUri
jump to class

$_httpClient
jump to class

$_registeredPackages
jump to class

$_staticHttpClient
jump to class

$namespaces
jump to class

__construct
jump to class

getEntry
jump to class

getFeed
jump to class

import
jump to class

isAuthenticated
jump to class

performHttpRequest
jump to class