Zend_Gdata | Zend_Gdata Programmer's Reference Guide | Authenticating with AuthSub

# Introduction

Google Data APIs provide programmatic interface to some of Google's online services. The Google data Protocol is based upon the » Atom Publishing Protocol and allows client applications to retrieve data matching queries, post data, update data and delete data using standard HTTP and the Atom syndication formation. The Zend_Gdata component is a PHP 5 interface for accessing Google Data from PHP. The Zend_Gdata component also supports accessing other services implementing the Atom Publishing Protocol.

See » http://code.google.com/apis/gdata/ for more information about Google Data API.

The services that are accessible by Zend_Gdata include the following:

- Google Calendar is a popular online calendar application.

- Google Spreadsheets provides an online collaborative spreadsheets tool which can be used as a simple data store for your applications.

- Google Documents List provides an online list of all spreadsheets, word processing documents, and presentations stored in a Google account.

- Google Provisioning provides the ability to create, retrieve, update, and delete user accounts, nicknames, and email lists on a Google Apps hosted domain.

- Google Base provides the ability to retrieve, post, update, and delete items in Google Base.

- YouTube provides the ability to search and retrieve videos, comments, favorites, subscriptions, user profiles and more.

- Picasa Web Albums provides an online photo sharing application.

- » Google Blogger is a popular Internet provider of "push-button publishing" and syndication.

- Google CodeSearch allows you to search public source code from many projects.

- Google Notebook allows you to view public Notebook content.

> Note: Unsupported services
> Zend_Gdata does not provide an interface to any other Google service, such as Search, Gmail, Translation, or Maps. Only services that support the Google Data API are supported.

# Structure of Zend_Gdata

Zend_Gata is composed of several types of classes:

- Service classes - inheriting from Zend_Gdata_App. These also include other classes such as Zend_Gdata, Zend_Gdata_Spreadsheets, etc. These classes enable interacting with APP or GData services and provide the ability to retrieve feeds, retrieve entries, post entries, update entries and delete entries.

- Query classes - inheriting from Zend_Gdata_Query. These also include other classes for specific services, such as Zend_Gdata_Spreadsheets_ListQuery and Zend_Gdata_Spreadsheets_CellQuery. Query classes provide methods used to construct a query for data to be retrieved from GData services. Methods include getters and setters like setUpdatedMin(), setStartIndex(), and getPublishedMin(). The query classes also have a method to generate a URL representing the constructed query -- `getQueryUrl`. Alternatively, the query string component of the URL can be retrieved used the getQueryString() method.

- Feed classes - inheriting from Zend_Gdata_App_Feed. These also include other classes such as Zend_Gdata_Feed, Zend_Gdata_Spreadsheets_SpreadsheetFeed, and Zend_Gdata_Spreadsheets_ListFeed. These classes represent feeds of entries retrieved from services. They are primarily used to retrieve data returned from services.

- Entry classes - inheriting from Zend_Gdata_App_Entry. These also include other classes such as Zend_Gdata_Entry, and Zend_Gdata_Spreadsheets_ListEntry. These classes represent entries retrieved from services or used for constructing data to send to services. In addition to being able to set the properties of an entry (such as the spreadsheet cell value), you can use an entry object to send update or delete requests to a service. For example, you can call `$entry->save()` to save changes made to an entry back to service from which the entry initiated, or `$entry->delete()` to delete an entry from the server.

- Other Data model classes - inheriting from Zend_Gdata_App_Extension. These include classes such as Zend_Gdata_App_Extension_Title (representing the atom:title XML element), Zend_Gdata_Extension_When (representing the gd:when XML element used by the GData Event "Kind"), and Zend_Gdata_Extension_Cell (representing the gs:cell XML element used by Google Spreadsheets). These classes are used purely to store the data retrieved back from services and for constructing data to be sent to services. These include getters and setters such as setText() to set the child text node of an element, getText() to retrieve the text node of an element, getStartTime() to retrieve the start time attribute of a When element, and other similiar methods. The data model classes also include methods such as getDOM() to retrieve a DOM representation of the element and all children and transferFromDOM() to construct a data model representation of a DOM tree.

# Interacting with Google Services

Google data services are based upon the Atom Publishing Protocol (APP) and the Atom syndication format. To interact with APP or Google services using the Zend_Gdata component, you need to use the service classes such as Zend_Gdata_App, Zend_Gdata, Zend_Gdata_Spreadsheets, etc. These service classes provide methods to retrieve data from services as feeds, insert new entries into feeds, update entries, and delete entries.

Note: A full example of working with Zend_Gdata is available in the `demos/Zend/Gdata` directory. This example is runnable from the command-line, but the methods contained within are easily portable to a web application.

# Obtaining instances of Zend_Gdata classes

The Zend Framework naming standards require that all classes be named based upon the directory structure in which they are located. For instance, extensions related to Spreadsheets are stored in: `Zend/Gdata/Spreadsheets/Extension/...` and, as a result of this, are named Zend_Gdata_Spreadsheets_Extension_.... This causes a lot of typing if you're trying to construct a new instance of a spreadsheet cell element!

We've implemented a magic factory method in all service classes (such as Zend_Gdata_App, Zend_Gdata, Zend_Gdata_Spreadsheets) that should make constructing new instances of data model, query and other classes much easier. This magic factory is implemented by using the magic `__call` method to intercept all attempts to call `$service->newXXX(arg1, arg2, ...)`. Based off the value of XXX, a search is performed in all registered 'packages' for the desired class. Here's some examples:

1. $ss = new Zend_Gdata_Spreadsheets();
3. // creates a Zend_Gdata_App_Spreadsheets_CellEntry
4. $entry = $ss->newCellEntry();
6. // creates a Zend_Gdata_App_Spreadsheets_Extension_Cell
7. $cell = $ss->newCell();
8. $cell->setText('My cell value');
9. $cell->setRow('1');
10. $cell->setColumn('3');
11. $entry->cell = $cell;
13. // ... $entry can then be used to send an update to a Google Spreadsheet

Each service class in the inheritance tree is responsible for registering the appropriate 'packages' (directories) which are to be searched when calling the magic factory method.

# Google Data Client Authentication

Most Google Data services require client applications to authenticate against the Google server before accessing private data, or saving or deleting data. There are two implementations of authentication for Google Data: AuthSub and ClientLogin. Zend_Gdata offers class interfaces for both of these methods.

Most other types of queries against Google Data services do not require authentication.

# Dependencies

Zend_Gdata makes use of Zend_Http_Client to send requests to google.com and fetch results. The response to most Google Data requests is returned as a subclass of the Zend_Gdata_App_Feed or Zend_Gdata_App_Entry classes.

Zend_Gdata assumes your PHP application is running on a host that has a direct connection to the Internet. The Zend_Gdata client operates by contacting Google Data servers.

# Creating a new Gdata client

Create a new object of class Zend_Gdata_App, Zend_Gdata, or one of the subclasses available that offer helper methods for service-specific behavior.

The single optional parameter to the Zend_Gdata_App constructor is an instance of Zend_Http_Client. If you don't pass this parameter, Zend_Gdata creates a default Zend_Http_Client object, which will not have associated credentials to access private feeds. Specifying the Zend_Http_Client object also allows you to pass configuration options to that client object.

1. $client = new Zend_Http_Client();
2. $client->setConfig( ...options... );
4. $gdata = new Zend_Gdata($client);

Beginning with Zend Framework 1.7, support has been added for protocol versioning. This allows the client and server to support new features while maintaining backwards compatibility. While most services will manage this for you, if you create a Zend_Gdata instance directly (as opposed to one of its subclasses), you may need to specify the desired protocol version to access certain server functionality.

1. $client = new Zend_Http_Client();
2. $client->setConfig( ...options... );
4. $gdata = new Zend_Gdata($client);
5. $gdata->setMajorProtocolVersion(2);
6. $gdata->setMinorProtocolVersion(null);

Also see the sections on authentication for methods to create an authenticated Zend_Http_Client object.

# Common Query Parameters

You can specify parameters to customize queries with Zend_Gdata. Query parameters are specified using subclasses of Zend_Gdata_Query. The Zend_Gdata_Query class includes methods to set all query parameters used throughout GData services. Individual services, such as Spreadsheets, also provide query classes to defined parameters which are custom to the particular service and feeds. Spreadsheets includes a CellQuery class to query the Cell Feed and a ListQuery class to query the List Feed, as different query parameters are applicable to each of those feed types. The GData-wide parameters are described below.

- The `q` parameter specifies a full-text query. The value of the parameter is a string.

  Set this parameter with the setQuery() function.

- The `alt` parameter specifies the feed type. The value of the parameter can be `atom`, `rss`, `json`, or `json-in-script`. If you don't specify this parameter, the default feed type is `atom`. NOTE: Only the output of the atom feed format can be processed using Zend_Gdata. The Zend_Http_Client could be used to retrieve feeds in other formats, using query URLs generated by the Zend_Gdata_Query class and its subclasses.

  Set this parameter with the setAlt() function.

- The `maxResults` parameter limits the number of entries in the feed. The value of the parameter is an integer. The number of entries returned in the feed will not exceed this value.

  Set this parameter with the setMaxResults() function.

- The `startIndex` parameter specifies the ordinal number of the first entry returned in the feed. Entries before this number are skipped.

  Set this parameter with the setStartIndex() function.

- The `updatedMin` and `updatedMax` parameters specify bounds on the entry date. If you specify a value for `updatedMin`, no entries that were updated earlier than the date you specify are included in the feed. Likewise no entries updated after the date specified by `updatedMax` are included.

  You can use numeric timestamps, or a variety of date/time string representations as the value for these parameters.

  Set this parameter with the setUpdatedMin() and setUpdatedMax() functions.

There is a `get` function for each `set` function.

1. $query = new Zend_Gdata_Query();
2. $query->setMaxResults(10);
3. echo $query->getMaxResults(); // returns 10

The Zend_Gdata class also implements "magic" getter and setter methods, so you can use the name of the parameter as a virtual member of the class.

1. $query = new Zend_Gdata_Query();
2. $query->maxResults = 10;
3. echo $query->maxResults; // returns 10

You can clear all parameters with the resetParameters() function. This is useful to do if you reuse a Zend_Gdata object for multiple queries.

1. $query = new Zend_Gdata_Query();
2. $query->maxResults = 10;
3. // ...get feed...
5. $query->resetParameters(); // clears all parameters
6. // ...get a different feed...

# Fetching a Feed

Use the getFeed() function to retrieve a feed from a specified URI. This function returns an instance of class specified as the second argument to getFeed, which defaults to Zend_Gdata_Feed.

1. $gdata = new Zend_Gdata();
2. $query = new Zend_Gdata_Query(
3. 'http://www.blogger.com/feeds/blogID/posts/default');
4. $query->setMaxResults(10);
5. $feed = $gdata->getFeed($query);

See later sections for special functions in each helper class for Google Data services. These functions help you to get feeds from the URI that is appropriate for the respective service.

# Working with Multi-page Feeds

When retrieving a feed that contains a large number of entries, the feed may be broken up into many smaller "pages" of feeds. When this occurs, each page will contain a link to the next page in the series. This link can be accessed by calling getLink('next'). The following example shows how to retrieve the next page of a feed:

1. function getNextPage($feed) {
2. $nextURL = $feed->getLink('next');
3. if ($nextURL !== null) {
4. return $gdata->getFeed($nextURL);
5. } else {
6. return null;
7. }
8. }

If you would prefer not to work with pages in your application, pass the first page of the feed into Zend_Gdata_App::retrieveAllEntriesForFeed(), which will consolidate all entries from each page into a single feed. This example shows how to use this function:

1. $gdata = new Zend_Gdata();
2. $query = new Zend_Gdata_Query(
3. 'http://www.blogger.com/feeds/blogID/posts/default');
4. $feed = $gdata->retrieveAllEntriesForFeed($gdata->getFeed($query));

Keep in mind when calling this function that it may take a long time to complete on large feeds. You may need to increase PHP's execution time limit by calling set_time_limit().

# Working with Data in Feeds and Entries

After retrieving a feed, you can read the data from the feed or the entries contained in the feed using either the accessors defined in each of the data model classes or the magic accessors. Here's an example:

1. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
2. $gdata = new Zend_Gdata($client);
3. $query = new Zend_Gdata_Query(
4. 'http://www.blogger.com/feeds/blogID/posts/default');
5. $query->setMaxResults(10);
6. $feed = $gdata->getFeed($query);
7. foreach ($feed as $entry) {
8. // using the magic accessor
9. echo 'Title: ' . $entry->title->text;
10. // using the defined accessors
11. echo 'Content: ' . $entry->getContent()->getText();
12. }

# Updating Entries

After retrieving an entry, you can update that entry and save changes back to the server. Here's an example:

1. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
2. $gdata = new Zend_Gdata($client);
3. $query = new Zend_Gdata_Query(
4. 'http://www.blogger.com/feeds/blogID/posts/default');
5. $query->setMaxResults(10);
6. $feed = $gdata->getFeed($query);
7. foreach ($feed as $entry) {
8. // update the title to append 'NEW'
9. echo 'Old Title: ' . $entry->title->text;
10. $entry->title->text = $entry->title->text . ' NEW';
12. // update the entry on the server
13. $newEntry = $entry->save();
14. echo 'New Title: ' . $newEntry->title->text;
15. }

# Posting Entries to Google Servers

The Zend_Gdata object has a function insertEntry() with which you can upload data to save new entries to Google Data services.

You can use the data model classes for each service to construct the appropriate entry to post to Google's services. The insertEntry() function will accept a child of Zend_Gdata_App_Entry as data to post to the service. The method returns a child of Zend_Gdata_App_Entry which represents the state of the entry as it was returned from the server.

Alternatively, you could construct the XML structure for an entry as a string and pass the string to the insertEntry() function.

1. $gdata = new Zend_Gdata($authenticatedHttpClient);
3. $entry = $gdata->newEntry();
4. $entry->title = $gdata->newTitle('Playing football at the park');
5. $content =
6. $gdata->newContent('We will visit the park and play football');
7. $content->setType('text');
8. $entry->content = $content;
10. $entryResult = $gdata->insertEntry($entry,
11. 'http://www.blogger.com/feeds/blogID/posts/default');
13. echo 'The <id> of the resulting entry is: ' . $entryResult->id->text;

To post entries, you must be using an authenticated Zend_Http_Client that you created using the Zend_Gdata_AuthSub or Zend_Gdata_ClientLogin classes.

# Deleting Entries on Google Servers

Option 1: The Zend_Gdata object has a function delete() with which you can delete entries from Google Data services. Pass the edit URL value from a feed entry to the delete() method.

Option 2: Alternatively, you can call `$entry->delete()` on an entry retrieved from a Google service.

1. $gdata = new Zend_Gdata($authenticatedHttpClient);
2. // a Google Data feed
3. $feedUri = ...;
4. $feed = $gdata->getFeed($feedUri);
5. foreach ($feed as $feedEntry) {
6. // Option 1 - delete the entry directly
7. $feedEntry->delete();
8. // Option 2 - delete the entry by passing the edit URL to
9. // $gdata->delete()
10. // $gdata->delete($feedEntry->getEditLink()->href);
11. }

To delete entries, you must be using an authenticated Zend_Http_Client that you created using the Zend_Gdata_AuthSub or Zend_Gdata_ClientLogin classes.

Zend_Gdata | Zend_Gdata Programmer's Reference Guide | Authenticating with AuthSub