Zend_Gata besteht aus verschiedenen Typen von Klassen:

Google Daten Services basieren auf dem Atom Publishing Protokoll (APP) und dem Atom Syndication Format. Um mit APP oder den Google Services zu interagieren indem Zend_Gdata verwendet wird, müssen Service Klassen wie Zend_Gdata_App, Zend_Gdata, Zend_Gdata_Spreadsheets, usw. verwendet werden. Diese Service Klassen bieten Methoden um Daten von Services als Feeds zu empfangen, neue Einträge in Feeds einzufügen, Einträge zu aktuslieieren und Einträge zu löschen.

Achtung: Ein komplettes Beispiel davon wie mit Zend_Gdata gearbeitet werden kann ist im demos/Zend/Gdata Verzeichnis vorhanden. Dieses Beispiel läuft von der Kommandozeile aus, aber die enthaltenen Methoden sind einfach in einem Web Anwendung zu portieren.

Der Zend Framework Namensstandard erzwingt das alle Klassen nach der Verzeichnis Struktur benannt werden in welcher sie vorhanden sind. Zum Beispiel eine Erweiterung die zu Tabellenkalkulation gehört und in Zend/Gdata/Spreadsheets/Extension/... gespeichert ist, muß als Ergebnis Zend_Gdata_Spreadsheets_Extension_... benannt werden. Das verursacht eine Menge an Tipparbeit wenn versucht wird eine neue Instanz eines Zellen Elements zu erstellen!

Wir haben eine magische Fabriksmethode in alle Service Klassen (wie Zend_Gdata_App, Zend_Gdata, Zend_Gdata_Spreadsheets) implementiert welche die Erstellung neuer Instanzen von Daten Modellen, Abfragen und anderen Klassen viel einfacher macht. Diese magische Fabriksmethode ist durch die Verwendung der magischen __call() Methode implementiert um auf alle Versuche $service->newXXX(arg1, arg2, ...) aufzurufen, angewendet zu werden. Basieren auf dem Wert von XXX, wird eine Suche in allen registrierten 'Paketen', für die gewünschte Klasse, durchgeführt. Hier sind einige Beispiele:

$ss = new Zend_Gdata_Spreadsheets();

// Erstellt ein Zend_Gdata_App_Spreadsheets_CellEntry
$entry = $ss->newCellEntry();

// Erstellt ein Zend_Gdata_App_Spreadsheets_Extension_Cell
$cell = $ss->newCell();
$cell->setText('Mein Zellenwert');
$cell->setRow('1');
$cell->setColumn('3');
$entry->cell = $cell;

// ... $entry kann dann verwendet werden um eine Aktualisierung
// an eine Google Tabellenkalkulation zu senden

Jede Service Klasse im abgeleiteten Baum ist dafür verantwortlich das die richtigen 'Pakete' (Verzeichnisse) registriert werden, in welchen dann durch den Aufruf der matischen Fabriksmethode, gesucht wird.

Die meisten Google Daten Services erfordern das sich die Client Anwendung auf dem Google Server authentifiziert bevor auf private Daten zugegriffen, oder Daten gespeichert oder gelöscht werden können. Es gibt zwei Implementationen der Authentifizierung für Google Daten: AuthSub und ClientLogin. Zend_Gdata bietet Klassen Interfaces für beide dieser Methoden.

Die meisten anderen Typen von Abfragen auf Google Daten Servicen benötigen keine Authentifizierung.

Zend_Gdata verwendet Zend_Http_Client um Anfragen an google.com zu senden und Ergebnisse zu erhalten. Die Antworter der meisten Google Data Anfragen werden als Subklasse von Zend_Gdata_App_Feed oder Zend_Gdata_App_Entry Klassen zurückgegeben.

Zend_Gdata nimmt an das die PHP Anwendung auf einem Host läuft der eine direkte Verbindung zum Internet hat. Der Zend_Gdata Client arbeitet indem er zu Google Daten Servern Kontakt aufnimmt.

Man muß ein neues Objekt der Klasse Zend_Gdata_App, Zend_Gdata, oder einer dessen Subklassen erstellen die Helfer Methoden für servicespezifische Verhaltensweisen anbieten.

Der einzige optionale Parameter für den Konstruktor von Zend_Gdata_App ist eine Instanz von Zend_Http_Client. Wenn dieser Parameter nicht übergeben wird, erstellt Zend_Gdata ein standardmäßiges Zend_Http_Client Objekt, welches keine Zugangsdaten zugeordnet hat um auf private Feeds zugreifen zu können. Die Spezifizierung des Zend_Http_Client Objektes erlaubt es auch Konfigurationsoptionen an das Client Objekt zu übergeben.

$client = new Zend_Http_Client();
$client->setConfig( ...options... );

$gdata = new Zend_Gdata($client);

Beginnend mit Zend Framework 1.7, wurde die Unterstützung für die Versionierung des Protkolls hinzugefügt. Das erlaut dem Client und Server neue Fesatures zu unterstützen, während die Rückwärts Kompatibilität gewahrt bleibt. Wärend die meisten Services das für dich selbst durchführen, wenn man eine Zend_Gdata Instanz direkt erstellt (als Gegensatz zu einer Ihrer Unterklassen), kann es sein das man die gewünschte Version des Protokolls spezifizieren will um auf spezielle Serverfunktionalitäten zugreifen zu können.

$client = new Zend_Http_Client();
$client->setConfig( ...options... );

$gdata = new Zend_Gdata($client);
$gdata->setMajorProtocolVersion(2);
$gdata->setMinorProtocolVersion(null);

Siehe auch die Sektion über Authentifizierung für Methoden, um ein authentifiziertes Zend_Http_Client Objekt zu erstellen.

Es können Parameter spezifiziert werden um Abfragen mit Zend_Gdata anzupassen. Abfrageparameter werden spezifiziert indem Subklassen von Zend_Gdata_Query verwendet werden. Die Zend_Gdata_Query Klasse beinhaltet Methoden um alle Abfrageparameter zu setzen die von Gdata Services verwendet werden. Individuelle Services, wie Tabellenkalkulationen, bieten auch Abfrageklassen zu definierten Parametern welche an das spezielle Service und die Feeds angepasst sind. Tabellenkalkulationen beinhalten eine CellQuery Klasse um den Zellen Feed abzufragen und eine ListQuery Klasse um den Listen Feed abzufragen, da verschiedene Abfrageparameter für jeder dieser Feedtypen möglich sind. Die GData-weiten Parameter werden anbei beschrieben.

Es gibt eine get*() Funktion für jede set*() Funktion.

$query = new Zend_Gdata_Query();
$query->setMaxResults(10);
echo $query->getMaxResults();   // gibt 10 zurück

Die Zend_Gdata Klasse implementiert auch "magische" Getter und Setter Methoden, es kann also der Name des Parameters als virtuelles Mitglied der Klasse verwendet werden.

$query = new Zend_Gdata_Query();
$query->maxResults = 10;
echo $query->maxResults;        // gibt 10 zurück

Es können alle Parameter mit der resetParameters() Funktion gelöscht werden. Das ist nützlich wenn ein Zend_Gdata Objekt für mehrfache Abfragen wiederverwendet werden soll.

$query = new Zend_Gdata_Query();
$query->maxResults = 10;
// ...den Feed empfangen...

$query->resetParameters();      // löscht alle Parameter
// ...einen anderen Feed empfangen...

Die getFeed() Funktion kann verwendet werden um einen Feed von einer spezifizierten URI zu empfangen. Diese Funktion gibt eine Instanz der Klasse, die als zweites Argument an getFeed übergeben wurde, zurück, welche standardmäßig Zend_Gdata_Feed ist.

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

Siehe spätere Sektionen für spezielle Funktionen in jeder Helfer Klasse für Google Daten Services. Diese Funktionen helfen Feeds von einer URI zu empfangen die für das angeforderte Service zuständig ist.

Wenn man einen Feed empfängt der eine große Anzahl an Einträgen enthält, kann dieser Feed in viele kleinere "Seiten" von Feeds gebrochen werden. Wenn das passiert, enthält jede Seite einen Link zur nächsten Seite der Serie. Auf diesen Link kann mit Hilfe von getLink('next') zugegriffen werden. Das folgende Beispiel zeigt wie auf die nächste Seite eines Feeds empfangen werden kann:

function getNextPage($feed) {
    $nextURL = $feed->getLink('next');
    if ($nextURL !== null) {
        return $gdata->getFeed($nextURL);
    } else {
        return null;
    }
}

Wenn man es vorzieht nicht mit Seiten in der eigenen Anwendung zu arbeiten, kann die erste Seite des Feeds an Zend_Gdata_App::retrieveAllEntriesForFeed() übergeben werden, welche alle Einträge von jeder Seite in einen einzelnen Feed zusammenfasst. Dieses Beispiel zeigt wie diese Funktion verwendet werden kann:

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

Es gilt zu beachten das wenn diese Funktion aufgerufen wird, dies eine sehr lange Zeit benötigen kann im große Feeds zu komplettieren. Es kann notwendig sein PHP's Limit der Ausführungszeit zu vergrößern mithilfe von set_time_limit() zu vergrößern.

Nachdem ein Feed empfangen wurde, können die Daten von dem Feed oder den Einträgen die in dem Feed enthalten sind, gelesen werden, indem entweder die in jeder Daten Modell Klasse definierten Zugriffsmethoden oder die magischen Zugriffsmethoden verwendet werden. Hier ist ein Beispiel:

$client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
$gdata = new Zend_Gdata($client);
$query = new Zend_Gdata_Query(
        'http://www.blogger.com/feeds/blogID/posts/default');
$query->setMaxResults(10);
$feed = $gdata->getFeed($query);
foreach ($feed as $entry) {
    // Die magischen Zugriffsmethoden verwenden
    echo 'Titel: ' . $entry->title->text;
    // Die definierten Zugriffsmethoden verwenden
    echo 'Inhalt: ' . $entry->getContent()->getText();
}

Nachdem ein Eintrag empfangen wurde, kann dieser Eintrag aktualisiert und die Änderungen an den Server zurück gespeichert werden. Hier ist ein Beispiel:

$client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
$gdata = new Zend_Gdata($client);
$query = new Zend_Gdata_Query(
        'http://www.blogger.com/feeds/blogID/posts/default');
$query->setMaxResults(10);
$feed = $gdata->getFeed($query);
foreach ($feed as $entry) {
    // Dem Titel 'NEU' hinzufügen
    echo 'Alter Titel: ' . $entry->title->text;
    $entry->title->text = $entry->title->text . ' NEU';

    // Den Eintrag auf dem Server aktualisieren
    $newEntry = $entry->save();
    echo 'New Title: ' . $newEntry->title->text;
}

Das Zend_Gdata Objekt hat eine insertEntry() Funktion mit der man Daten hochladen kann um neue Einträge in Google Data Services zu speichern.

Die Daten Modell Klassen jedes Services kann verwendet werden um einen entsprechenden Eintrag zu erstellen und an Google's Services zu schicken. Die insertEntry() Funktion akzeptiert ein Kind von Zend_Gdata_App_Entry als Daten die an den Service geschickt werden. Die Methode gibt ein Kind von Zend_Gdata_App_Entry zurück welches den Status des Eintrages repräsentiert der vom Server zurückgegeben wurde.

Alternativ, kann die XML Struktur eines Eintrages als String konstruiert und dieser String an die insertEntry() Funktion übergeben werden.

$gdata = new Zend_Gdata($authenticatedHttpClient);

$entry = $gdata->newEntry();
$entry->title = $gdata->newTitle('Füßball im Park spielen');
$content =
    $gdata->newContent('Wir besuchen den Part und spielen Fußball');
$content->setType('text');
$entry->content = $content;

$entryResult = $gdata->insertEntry($entry,
        'http://www.blogger.com/feeds/blogID/posts/default');

echo 'Die <id> des resultierenden Eintrages ist: ' . $entryResult->id->text;

Um Einträge zu senden, muß ein authentifizierter Zend_Http_Client verwendet werden der mit Hilfe der Zend_Gdata_AuthSub oder Zend_Gdata_ClientLogin Klassen erstellt wurde.

Option 1: Das Zend_Gdata Objekt hat eine delete() Funktion mit der Einträge von Google Daten Services gelöscht werden können. Der bearbeitete URL Wert eines Feed Eintrages kann der delete() Methode übergeben werden.

Option 2: Alternativ kann $entry->delete() an einem Eintrag der von einem Google Service empfangen wurde, aufgerufen werden.

$gdata = new Zend_Gdata($authenticatedHttpClient);
// ein Google Daten Feed
$feedUri = ...;
$feed = $gdata->getFeed($feedUri);
foreach ($feed as $feedEntry) {
    // Option 1 - den Eintrag direkt löschen
    $feedEntry->delete();
    // Option 2 - den eintrag durch Übergabe der bearbeiteten URL an
    // $gdata->delete() löschen
    // $gdata->delete($feedEntry->getEditLink()->href);
}

Um Einträge zu löschen, muß ein authentifizierter Zend_Http_Client verwendet werden der mit Hilfe der Zend_Gdata_AuthSub oder Zend_Gdata_ClientLogin Klassen erstellt wurde.