Documentation

Einführung - Zend_Gdata

Einführung

Die APIs von Google Data bieten ein programmtechnisches Interface zu einigen von Google's Online Services. Das Google Data Protokoll basiert auf dem » Atom Publishing Protokoll und erlaubt Client Anwendungen das Empfangen von passenden Anfragen zu Daten, senden von Daten, modifizieren von Daten und löschen von Daten wobei Standard HTTP und das Atom Syndication Format verwendet wird. Die Zend_Gdata Komponente ist ein PHP 5 Interface für den Zugriff auf Daten von Google von PHP aus. Die Zend_Gdata Komponente unterstützt auch den Zugriff auf andere Services die das Atom Publishing Protokoll implementieren.

Siehe » http://code.google.com/apis/gdata/ für mehr Informationen über die Google Data API.

Die Services auf die durch Zend_Gdata zugegriffen werden kann beinhalten unter anderem:

  • Google Kalender ist eine populäre online Kalender Anwendung.

  • Google Tabellenkalkulation bietet ein gemeinschaftliches online Tabellenkalkulations Tool welches als einfacher Datenspeicher für eigene Anwendungen verwendet werden kann.

  • Google Dokumenten Liste bietet eine online Liste von allen Tabellenkalkulationen, Wortbearbeitungs Dokumenten, und Präsentationen die in einem Google Account gespeichert sind.

  • Google Versorgung bietet die Möglichkeit Benutzerdaten, Spitznamen, Gruppen und Emaillisten auf einer Google Apps gehosten Domain zu erstellen, erhalten, aktualisieren und zu löschen.

  • Picasa Web Album bietet eine online Photo Sharing Anwendung.

  • Google Analytics bietet eine Besucher-Analyse Anwendung.

  • » Google Blogger ist ein populärer Internet Provider von "push-button Veröffentlichung" und Verbreitung.

  • Google CodeSearch erlaubt das Suchen von öffentlichem Source Code für viele Projekte.

  • Google Notebook erlaubt das sehen von veröffentlichten Notebook Inhalten.

Note: Nicht unterstützte Services
Zend_Gdata bietet kein Interface zu irgendwelchen anderen Google Services wie Search, Gmail, Translation oder Maps. Nur Services die das Google Data API unterstützen werden unterstützt.

Struktur von Zend_Gdata

Zend_Gata besteht aus verschiedenen Typen von Klassen:

  • Service Klassen - abgeleitet von Zend_Gdata_App. Diese beinhalten auch andere Klassen wie Zend_Gdata, Zend_Gdata_Spreadsheeps, usw. Diese Klassen erlauben die Interaktion mit APP oder GData Services und bieten die Möglichkeit Feeds und Einträge zu empfangen, Einträge zu senden, zu aktualisieren und zu löschen.

  • Abfrage Klassen - abgeleitet von Zend_Gdata_Query. Diese beinhalten auch andere Klassen für spezielle Services, wie Zend_Gdata_Spreadsheet_ListQuery und Zend_Gdata_Spreadsheets_CellQuery. Abfrage Klassen bieten Methoden die verwendet werden können um Abfragen für Daten zu erstellen die von GData Services empfangen werden. Die Methoden inkludieren Getter und Setter wie setUpdatedMin(), setStartIndex(), und getPublishedMin(). Die Abfrage Klassen haben auch eine Methode um eine URL zu erhalten welche die erstellte Abfrage repräsentieren. -- getQueryUrl(). Alternativ kann man die Abfrage String Komponente der URL erhalten indem die getQueryString() Methode verwendet wird.

  • Feed Klassen - abgeleitet von Zend_Gdata_App_Feed. Diese beinhalten auch andere Klassen wie Zend_Gdata_Feed, Zend_Gdata_Spreadsheets_SpreadsheetFeed, und Zend_Gdata_Spreadsheets_ListFeed. Diese Klassen repräsentieren Feeds von Einträgen die von Services empfangen wurden. Sie werden primär verwendet um Daten die von Services zurückgegeben werden zu erhalten.

  • Eingabe Klassen - abgeleitet von Zend_Gdata_App_Entry. Diese beinhalten auch andere Klassen wie Zend_Gdata_Entry, und Zend_Gdata_Spreadsheets_ListEntry. Diese Klassen repräsentieren Einträge die von Services empfangen oder für die Erstellung von Daten, die an Services geschickt werden, verwendet werden. Zusätzlich zur Möglichkeit die Eigenschaften eines Eintrages (wie den Zellen Wert der Tabellenkalkulation) zu setzen, kann das Objekt des Eintrages verwendet werden um Aktualisierungs- oder Löschanfragen an ein Service zu senden. Zum Beispiel kann $entry->save() aufgerufen werden um Änderungen die an einem Eintrage durchgeführt wurden zu einem Service zurück zu Speichern von welche der Eintrag initiiert wurde, oder $entry->delete() um einen Eintrag von einem Server zu Löschen.

  • Andere Daten Modell Klassen - abgeleitet von Zend_Gdata_App_Extension. Diese beinhalten Klassen wie Zend_Gdata_App_Extension_Title (repräsentiert das atom:title XML Element), Zend_Gdata_Extension_When (repräsentiert das gd:when XML Element das von dem GData Event "Kind" verwendet wird), und Zend_Gdata_Extension_Cell (repräsentiert das gs:cell XML Element das von Google Tabellenkalkulation verwendet wird). Diese Klassen werden pur verwendet um von den Server zurückgegebene Daten zu speichern und für die Erstellung von Daten die an Services gesendet werden. Diese beinhalten Getter und Setter wie setText() um den Kindtext Node eines Elements zu setzen, getText() um den Text Node eines Elements zu erhalten, getStartTime() um das Startzeit Attribut eines When Elements oder anderen ähnlichen Methoden zu empfangen. Die Daten Modell Klassen beinhalten auch Methoden wie getDOM() um eine DOM Repräsentation des Elements und aller Kinder zu erhalten, und transferFromDOM() um eine Daten Modell Repräsentation des DOM Baumes zu erstellen.

Mit Google Services interagieren

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.

Instanzen von Zend_Gdata Klassen erhalten

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:

  1. $ss = new Zend_Gdata_Spreadsheets();
  2.  
  3. // Erstellt ein Zend_Gdata_App_Spreadsheets_CellEntry
  4. $entry = $ss->newCellEntry();
  5.  
  6. // Erstellt ein Zend_Gdata_App_Spreadsheets_Extension_Cell
  7. $cell = $ss->newCell();
  8. $cell->setText('Mein Zellenwert');
  9. $cell->setRow('1');
  10. $cell->setColumn('3');
  11. $entry->cell = $cell;
  12.  
  13. // ... $entry kann dann verwendet werden um eine Aktualisierung
  14. // 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.

Google Data Client Authentifizierung

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.

Abhängigkeiten

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.

Erstellen eines neuen Gdata Klienten

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.

  1. $client = new Zend_Http_Client();
  2. $client->setConfig( ...options... );
  3.  
  4. $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.

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

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

Übliche Abfrage Parameter

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.

  • Der q Parameter spezifiziert eine komplette Textabfrage. Der Wert dieses Parameters ist ein String.

    Dieser Parameter kann mit der setQuery() Methode gesetzt werden.

  • Der alt Parameter spezifiziert den Feed Typ. Der Wert dieses Parameters kann atom, rss, json, oder json-in-script sein. Wenn dieser Parameter nicht spezifiziert wird, ist der Standard Feedtyp atom. Zend_Http_Client könnte verwendet werden um Feeds in anderen Formaten zu empfangen, indem die von der Zend_Gdata_Query Klasse oder deren Subklassen erzeugten Abfrage URLs verwendet werden.

    Dieser Parameter kann mit der setAlt() Methode gesetzt werden.

  • Der maxResults Parameter begrenzt die Anzahl an Einträgen im Feed. Der Wert dieses Parameters ist ein Integer. Die zurückgegebene Anzahl an Einträgen im Feed wird diesen Wert nicht überschreiten.

    Dieser Parameter kann mit der setMaxResults() Methode gesetzt werden.

  • Der startIndex Parameter spezifiziert die ordinale Nummer des ersten Eintrags der im Feed zurückgegeben wird. Einträge vor dieser Nummer werden übergangen.

    Dieser Parameter kann mit der setStartIndex() Methode gesetzt werden.

  • Die Parameter updatedMin und updatedMax spezifizieren Grenzen für das Datum der Einträge. Wenn ein Wert für updatedMin spezifiziert wird, werden keine Einträge die vor dem spezifizierten Datum aktualisiert wurden, im Feed inkludiert. Genauso werden keine Einträge inkludiert die nach einem Datum aktualisiert wurden wenn updatedMax spezifiziert wird.

    Es können nummerische Zeitstempel, oder eine Variation von Datum/Zeit String Repräsentationen als Wert für diese Parameter verwendet werden.

    Diese Parameter kkönnen mit den setUpdatedMin() und setUpdatedMax() Methoden gesetzt werden.

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

  1. $query = new Zend_Gdata_Query();
  2. $query->setMaxResults(10);
  3. 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.

  1. $query = new Zend_Gdata_Query();
  2. $query->maxResults = 10;
  3. 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.

  1. $query = new Zend_Gdata_Query();
  2. $query->maxResults = 10;
  3. // ...den Feed empfangen...
  4.  
  5. $query->resetParameters();      // löscht alle Parameter
  6. // ...einen anderen Feed empfangen...

Einen 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.

  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);

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.

Mit Mehrfach-Seiten Feeds arbeiten

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:

  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. }

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:

  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));

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.

Arbeiten mit Daten in Feeds und Einträgen

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:

  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.     // Die magischen Zugriffsmethoden verwenden
  9.     echo 'Titel: ' . $entry->title->text;
  10.     // Die definierten Zugriffsmethoden verwenden
  11.     echo 'Inhalt: ' . $entry->getContent()->getText();
  12. }

Einträge aktualisieren

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

  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.     // Dem Titel 'NEU' hinzufügen
  9.     echo 'Alter Titel: ' . $entry->title->text;
  10.     $entry->title->text = $entry->title->text . ' NEU';
  11.  
  12.     // Den Eintrag auf dem Server aktualisieren
  13.     $newEntry = $entry->save();
  14.     echo 'New Title: ' . $newEntry->title->text;
  15. }

Einträge an Google Server schicken

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.

  1. $gdata = new Zend_Gdata($authenticatedHttpClient);
  2.  
  3. $entry = $gdata->newEntry();
  4. $entry->title = $gdata->newTitle('Füßball im Park spielen');
  5. $content =
  6.     $gdata->newContent('Wir besuchen den Part und spielen Fußball');
  7. $content->setType('text');
  8. $entry->content = $content;
  9.  
  10. $entryResult = $gdata->insertEntry($entry,
  11.         'http://www.blogger.com/feeds/blogID/posts/default');
  12.  
  13. 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.

Einträge auf einem Google Server löschen

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.

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

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.

Copyright

© 2006-2021 by Zend by Perforce. Made with by awesome contributors.

This website is built using zend-expressive and it runs on PHP 7.

Contacts