Gdata.php
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-2011 Zend Technologies USA Inc. (http://www.zend.com)
- license
-
New BSD License
- package
- Zend_Gdata
- subpackage
- Gdata
- version
- $Id: Gdata.php 23775 2011-03-01 17:25:24Z ralph $
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
- Extends from
- \Zend_Gdata_App
- category
- Zend
- copyright
- Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
- license
-
New BSD License
- link
-
http://code.google.com/apis/gdata/overview.html
- package
- Zend_Gdata
- subpackage
- Gdata
Constants


string
AUTH_SERVICE_NAME
= 'xapi'
Service name for use with Google's authentication mechanisms
Properties



string
$_defaultPostUri= 'null'
Default URI to which to POST.
Default valuenull
Details
- Type
- string



array
$_registeredPackages= 'array'
Packages to search for classes when using magic __call method, in order.
Default valuearray
Details
- Type
- array



array
$namespaces= 'array'
staticNamespaces used for Gdata data
Default valuearray
Details
- Type
- array
Methods



__call(
string $method, array $args
)
:
void
Provides a magic factory method to instantiate new objects with
shorter syntax than would otherwise be required by the Zend Framework
naming conventions. For instance, to construct a new
Zend_Gdata_Calendar_Extension_Color, a developer simply needs to do
$gCal->newColor(). For this magic constructor, packages are searched
in the same order as which they appear in the $_registeredPackages
array
Inherited from:
\Zend_Gdata_App::__call()
Parameters
Name |
Type |
Description |
$method |
string |
The method name being called |
$args |
array |
The arguments passed to the call |
Throws



__construct(
\Zend_Http_Client $client
=
null, string $applicationId
=
MyCompany-MyApp-1.0
)
:
void
Parameters
Name |
Type |
Description |
$client |
\Zend_Http_Client |
|
$applicationId |
string |
The identity of the app in the form of Company-AppName-Version
|



get(
string $uri, array $extraHeaders
=
array
)
:
\Zend_Http_Response
Parameters
Name |
Type |
Description |
$uri |
string |
GET URI |
$extraHeaders |
array |
Extra headers to add to the request, as an array of string-based key/value pairs.
|
Returns
Throws



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



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



import(
string $uri, \Zend_Http_Client $client
=
null, string $className
=
Zend_Gdata_Feed
)
:
string|\Zend_Gdata_App_Feed
staticImports 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



importUrl(
string $url, string $className
=
Zend_Gdata_App_Feed, array $extraHeaders
=
array
)
:
string|\Zend_Gdata_App_Feed
Parameters
Name |
Type |
Description |
$url |
string |
The URL to import |
$className |
string |
The class which is used as the return type |
$extraHeaders |
array |
Extra headers to add to the request, as an array of string-based key/value pairs.
|
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



insertEntry(
mixed $data, string $uri, string $className
=
Zend_Gdata_App_Entry, array $extraHeaders
=
array
)
:
\Zend_Gdata_App_Entry
Parameters
Name |
Type |
Description |
$data |
mixed |
The Zend_Gdata_App_Entry or XML to post |
$uri |
string |
POST URI |
$className |
string |
The class of entry to be returned. |
$extraHeaders |
array |
Extra headers to add to the request, as an array of string-based key/value pairs.
|
Returns



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



post(
mixed $data, string $uri
=
null, $remainingRedirects
=
null, string $contentType
=
null, array $extraHeaders
=
null
)
:
\Zend_Http_Response
Parameters
Name |
Type |
Description |
$data |
mixed |
The Zend_Gdata_App_Entry or XML to post |
$uri |
string |
POST URI |
$remainingRedirects |
|
|
$contentType |
string |
Content-type of the data
|
$extraHeaders |
array |
Extra headers to add to the request, as an array of string-based key/value pairs.
|
Returns
Throws



prepareRequest(
string $method, string $url
=
null, array $headers
=
array, mixed $data
=
null, string $contentTypeOverride
=
null
)
:
array
- Checks the $data element and, if it's an entry, extracts the XML,
multipart data, edit link (PUT,DELETE), etc.
- If $data is a string, sets the default content-type header as
'application/atom+xml' if it's not already been set.
- Adds a x-http-method override header and changes the HTTP method
to 'POST' if necessary as per getHttpMethodOverride()
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 |
$data |
mixed |
The Zend_Gdata_App_Entry or XML for the body of the request |
$contentTypeOverride |
string |
The override value for the content type of the request body |
Returns
Type |
Description |
array |
An associative array containing the determined 'method', 'url', 'data', 'headers', 'contentType' |



put(
mixed $data, string $uri
=
null, $remainingRedirects
=
null, string $contentType
=
null, array $extraHeaders
=
null
)
:
\Zend_Http_Response
Parameters
Name |
Type |
Description |
$data |
mixed |
The Zend_Gdata_App_Entry or XML to post |
$uri |
string |
PUT URI |
$remainingRedirects |
|
|
$contentType |
string |
Content-type of the data
|
$extraHeaders |
array |
Extra headers to add to the request, as an array of string-based key/value pairs.
|
Returns
Throws



registerPackage(
string $name
)
:
void
This array is searched when using the magic __call method below
to instantiante new objects.
Parameters
Name |
Type |
Description |
$name |
string |
The name of the package (eg Zend_Gdata_App)
|



setMinorProtocolVersion(
\(int|\NULL) $value
)
:
void
Set the minor protocol version that should be used. If set to NULL, no
minor protocol version will be sent to the server. Values < 0 will
cause a Zend_Gdata_App_InvalidArgumentException to be thrown.
Inherited from:
\Zend_Gdata_App::setMinorProtocolVersion()
Parameters
Name |
Type |
Description |
$value |
\(int|\NULL) |
The minor protocol version to use. |
Throws
Details
- see
- \_minorProtocolVersion



updateEntry(
mixed $data, string|null $uri
=
null, string|null $className
=
null, array $extraHeaders
=
array
)
:
\Zend_Gdata_App_Entry
Parameters
Name |
Type |
Description |
$data |
mixed |
Zend_Gdata_App_Entry or XML (w/ID and link rel='edit')
|
$uri |
string|null |
The URI to send requests to, or null if $data contains the URI.
|
$className |
string|null |
The name of the class that should be deserialized from the server response. If null, then 'Zend_Gdata_App_Entry' will be used.
|
$extraHeaders |
array |
Extra headers to add to the request, as an array of string-based key/value pairs.
|
Returns
Throws