Zend/Gdata.php

Show:

inherited

Classes
- \Zend_Gdata

Table of Contents

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.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Gdata
Subpackage: Gdata
Version: $Id: Gdata.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Gdata
jump to top

Package: Zend\Gdata\Gdata

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

Parent(s): \Zend_Gdata_App
Children: \Zend_Gdata_Calendar; \Zend_Gdata_Photos; \Zend_Gdata_Health; \Zend_Gdata_Analytics; \Zend_Gdata_DublinCore; \Zend_Gdata_Exif; \Zend_Gdata_Geo; \Zend_Gdata_Docs; \Zend_Gdata_Books; \Zend_Gdata_Gapps; \Zend_Gdata_Media; \Zend_Gdata_Spreadsheets; \Zend_Gdata_Gbase
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Link: http://code.google.com/apis/gdata/overview.html

Constants

string 
                AUTH_SERVICE_NAME
                = 'xapi'

Service name for use with Google's authentication mechanisms

: string

Properties

string
                 $_defaultPostUri= 'null'

Default URI to which to POST.

Default valuenullDetails

Type: string

\Zend_Gdata_HttpClient
                 $_httpClient= ''

Client object used to communicate

Details

Type: \Zend_Gdata_HttpClient

array
                 $_registeredPackages= 'array(
            'Zend_Gdata_Kind''

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

Default value

array(
            'Zend_Gdata_Kind'

Details

Type: array

\Zend_Gdata_HttpClient
                 $_staticHttpClient= 'null'

static

Client object used to communicate in static context

Default valuenullDetails

Type: \Zend_Gdata_HttpClient

array
                 $namespaces= 'array(
        array('gd''

static

Namespaces used for Gdata data

Default value

array(
        array('gd'

Details

Type: array

Methods

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

Create Gdata object

Parameters

Name	Type	Description
$client	\Zend_Http_Client
$applicationId	string	The identity of the app in the form of Company-AppName-Version

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

Retrieve entry as string or object

Parameters

Name	Type	Description
$location	mixed	The location as string or Zend_Gdata_Query
$className

Returns

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

Throws

Exception	Description
\Zend_Gdata_App_InvalidArgumentException

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

Retrieve feed as string or object

Parameters

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

Returns

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

Throws

Exception	Description
\Zend_Gdata_App_InvalidArgumentException

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

static

Imports a feed located at $uri.

Parameters

Name	Type	Description
$uri	string
$client	\Zend_Http_Client	The client used for communication
$className	string	The class which is used as the return type

Returns

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

Throws

Exception	Description
\Zend_Gdata_App_Exception

isAuthenticated(
          
          )
        
        :
          boolean

Determines whether service object is authenticated.

Returns

Type	Description
boolean	True if service object is authenticated, false otherwise.

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.

Parameters

Name	Type	Description
$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

Returns

Type	Description
\Zend_Http_Response	The response object

API Documentation

Zend/Gdata.php

\Zend_Gdatajump to top

Constants

Properties

Methods

\Zend_Gdata
jump to top