Zend_Gdata-Introduction.xml 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 16359 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.gdata.introduction">
  5. <title>Einführung</title>
  6. <para>
  7. Die APIs von Google Data bieten ein programmtechnisches Interface zu einigen von Google's
  8. Online Services. Das Google Data Protokoll basiert auf dem
  9. <ulink url="http://ietfreport.isoc.org/idref/draft-ietf-atompub-protocol/">Atom Publishing
  10. Protokoll</ulink> und erlaubt Client Anwendungen das Empfangen von passenden Anfragen zu
  11. Daten, senden von Daten, modifizieren von Daten und löschen von Daten wobei Standard HTTP
  12. und das Atom Syndication Format verwendet wird. Die <classname>Zend_Gdata</classname>
  13. Komponente ist ein PHP 5 Interface für den Zugriff auf Daten von Google von PHP aus. Die
  14. <classname>Zend_Gdata</classname> Komponente unterstützt auch den Zugriff auf andere
  15. Services die das Atom Publishing Protokoll implementieren.
  16. </para>
  17. <para>
  18. Siehe <ulink
  19. url="http://code.google.com/apis/gdata/">http://code.google.com/apis/gdata/</ulink> für
  20. mehr Informationen über die Google Data API.
  21. </para>
  22. <para>
  23. Die Services auf die durch <classname>Zend_Gdata</classname> zugegriffen werden kann
  24. beinhalten unter anderem:
  25. <itemizedlist>
  26. <listitem>
  27. <para>
  28. <link linkend="zend.gdata.calendar">Google Kalender</link> ist eine populäre
  29. online Kalender Anwendung.
  30. </para>
  31. </listitem>
  32. <listitem>
  33. <para>
  34. <link linkend="zend.gdata.spreadsheets">Google Tabellenkalkulation</link> bietet
  35. ein gemeinschaftliches online Tabellenkalkulations Tool welches als einfacher
  36. Datenspeicher für eigene Anwendungen verwendet werden kann.
  37. </para>
  38. </listitem>
  39. <listitem>
  40. <para>
  41. <link linkend="zend.gdata.docs">Google Dokumenten Liste</link> bietet eine
  42. online Liste von allen Tabellenkalkulationen, Wortbearbeitungs Dokumenten, und
  43. Präsentationen die in einem Google Account gespeichert sind.
  44. </para>
  45. </listitem>
  46. <listitem>
  47. <para>
  48. <link linkend="zend.gdata.gapps">Google Versorgung</link> bietet die Möglichkeit
  49. Benutzerdaten, Spitznamen und Emaillisten auf einer Google Apps gehosten Domain
  50. zu erstellen, erhalten, aktualisieren und zu löschen.
  51. </para>
  52. </listitem>
  53. <listitem>
  54. <para>
  55. <link linkend="zend.gdata.gbase">Google Base</link> bietet die Möglichkeit
  56. Elemente in Google Base zu empfangen, senden, aktualisieren und zu löschen.
  57. </para>
  58. </listitem>
  59. <listitem>
  60. <para>
  61. <link linkend="zend.gdata.youtube">YouTube</link> bietet die Möglichkeit Videos,
  62. Kommentare, Favoriten, Einschreibungen, Benutzerprofile und vieles mehr zu
  63. Suchen und zu Empfangen.
  64. </para>
  65. </listitem>
  66. <listitem>
  67. <para>
  68. <link linkend="zend.gdata.photos">Picasa Web Album</link> bietet eine online
  69. Photo Sharing Anwendung.
  70. </para>
  71. </listitem>
  72. <listitem>
  73. <para>
  74. <ulink url="http://code.google.com/apis/blogger/developers_guide_php.html">Google
  75. Blogger</ulink> ist ein populärer Internet Provider von "push-button
  76. Veröffentlichung" und Verbreitung.
  77. </para>
  78. </listitem>
  79. <listitem>
  80. <para>
  81. Google CodeSearch erlaubt das Suchen von öffentlichem Source Code für viele
  82. Projekte.
  83. </para>
  84. </listitem>
  85. <listitem>
  86. <para>
  87. Google Notebook erlaubt das sehen von veröffentlichten Notebook Inhalten.
  88. </para>
  89. </listitem>
  90. </itemizedlist>
  91. </para>
  92. <note>
  93. <title>Nicht unterstützte Services</title>
  94. <para>
  95. <classname>Zend_Gdata</classname> bietet kein Interface zu irgendwelchen anderen Google
  96. Services wie Search, Gmail, Translation oder Maps. Nur Services die das Google Data API
  97. unterstützen werden unterstützt.
  98. </para>
  99. </note>
  100. <sect2 id="zend.gdata.introduction.structure">
  101. <title>Struktur von Zend_Gdata</title>
  102. <para>
  103. <classname>Zend_Gata</classname> besteht aus verschiedenen Typen von Klassen:
  104. <itemizedlist>
  105. <listitem>
  106. <para>
  107. Service Klassen - abgeleitet von <classname>Zend_Gdata_App</classname>.
  108. Diese beinhalten auch andere Klassen wie <classname>Zend_Gdata</classname>,
  109. <classname>Zend_Gdata_Spreadsheeps</classname>, usw. Diese Klassen erlauben
  110. die Interaktion mit APP oder GData Services und bieten die Möglichkeit Feeds
  111. und Einträge zu empfangen, Einträge zu senden, zu aktualisieren und zu
  112. löschen.
  113. </para>
  114. </listitem>
  115. <listitem>
  116. <para>
  117. Abfrage Klassen - abgeleitet von <classname>Zend_Gdata_Query</classname>.
  118. Diese beinhalten auch andere Klassen für spezielle Services, wie
  119. <classname>Zend_Gdata_Spreadsheet_ListQuery</classname> und
  120. <classname>Zend_Gdata_Spreadsheets_CellQuery</classname>. Abfrage Klassen
  121. bieten Methoden die verwendet werden können um Abfragen für Daten zu
  122. erstellen die von GData Services empfangen werden. Die Methoden inkludieren
  123. Getter und Setter wie <code>setUpdatedMin()</code>,
  124. <code>setStartIndex()</code>, und <code>getPublishedMin()</code>. Die
  125. Abfrage Klassen haben auch eine Methode um eine URL zu erhalten die die
  126. erstellte Abfrage repräsentieren. -- <code>getQueryUrl</code>. Alternativ
  127. kann man die Abfrage String Komponente der URL erhalten indem die
  128. <code>getQueryString()</code> Methode verwendet wird.
  129. </para>
  130. </listitem>
  131. <listitem>
  132. <para>
  133. Feed Klassen - abgeleitet von <classname>Zend_Gdata_App_Feed</classname>.
  134. Diese beinhalten auch andere Klassen wie
  135. <classname>Zend_Gdata_Feed</classname>,
  136. <classname>Zend_Gdata_Spreadsheets_SpreadsheetFeed</classname>, und
  137. <classname>Zend_Gdata_Spreadsheets_ListFeed</classname>. Diese Klassen
  138. repräsentieren Feeds von Einträgen die von Services empfangen wurden. Sie
  139. werden primär verwendet um Daten die von Services zurückgegeben werden zu
  140. erhalten.
  141. </para>
  142. </listitem>
  143. <listitem>
  144. <para>
  145. Eingabe Klassen - abgeleitet von
  146. <classname>Zend_Gdata_App_Entry</classname>. Diese beinhalten auch andere
  147. Klassen wie <classname>Zend_Gdata_Entry</classname>, und
  148. <classname>Zend_Gdata_Spreadsheets_ListEntry</classname>. Diese Klassen
  149. repräsentieren Einträge die von Services empfangen oder für die Erstellung
  150. von Daten, die an Services geschickt werden, verwendet werden. Zusätzlich
  151. zur Möglichkeit die Eigenschaften eines Eintrages (wie den Zellen Wert der
  152. Tabellenkalkulation) zu setzen, kann das Objekt des Eintrages verwendet
  153. werden um Aktualisierungs- oder Löschanfragen an ein Service zu senden. Zum
  154. Beispiel kann <code>$entry->save()</code> aufgerufen werden um Änderungen
  155. die an einem Eintrage durchgeführt wurden zu einem Service zurück zu
  156. speichern von welche der Eintrag initiiert wurde, oder
  157. <code>$entry->delete()</code> um einen Eintrag von einem Server zu löschen.
  158. </para>
  159. </listitem>
  160. <listitem>
  161. <para>
  162. Andere Daten Modell Klassen - abgeleitet von
  163. <classname>Zend_Gdata_App_Extension</classname>. Diese beinhalten Klassen
  164. wie <classname>Zend_Gdata_App_Extension_Title</classname> (repräsentiert das
  165. atom:title XML Element), <classname>Zend_Gdata_Extension_When</classname>
  166. (repräsentiert das gd:when XML Element das von dem GData Event "Kind"
  167. verwendet wird), und <classname>Zend_Gdata_Extension_Cell</classname>
  168. (repräsentiert das gs:cell XML Element das von Google Tabellenkalkulation
  169. verwendet wird). Diese Klassen werden pur verwendet um von den Server
  170. zurückgegebene Daten zu speichern und für die Erstellung von Daten die an
  171. Services gesendet werden. Diese beinhalten Getter und Setter wie
  172. <code>setText()</code> um den Kindtext Node eines Elements zu setzen,
  173. <code>getText()</code> um den Text Node eines Elements zu erhalten,
  174. <code>getStartTime()</code> um das Startzeit Attribut eines When Elements
  175. oder anderen ähnlichen Methoden zu empfangen. Die Daten Modell Klassen
  176. beinhalten auch Methoden wie <code>getDOM()</code> um eine DOM
  177. Repräsentation des Elements und aller Kinder zu erhalten, und
  178. <code>transferFromDOM()</code> um eine Daten Modell Repräsentation des DOM
  179. Baumes zu erstellen.
  180. </para>
  181. </listitem>
  182. </itemizedlist>
  183. </para>
  184. </sect2>
  185. <sect2 id="zend.gdata.introduction.services">
  186. <title>Mit Google Services interagieren</title>
  187. <para>
  188. Google Daten Services basieren auf dem Atom Publishing Protokoll (APP) und dem Atom
  189. Syndication Format. Um mit APP oder den Google Services zu interagieren indem
  190. <classname>Zend_Gdata</classname> verwendet wird, müssen Service Klassen wie
  191. <classname>Zend_Gdata_App</classname>, <classname>Zend_Gdata</classname>,
  192. <classname>Zend_Gdata_Spreadsheets</classname>, usw. verwendet werden. Diese Service
  193. Klassen bieten Methoden um Daten von Services als Feeds zu empfangen, neue Einträge in
  194. Feeds einzufügen, Einträge zu aktuslieieren und Einträge zu löschen.
  195. </para>
  196. <para>
  197. Achtung: Ein komplettes Beispiel davon wie mit <classname>Zend_Gdata</classname>
  198. gearbeitet werden kann ist im <code>demos/Zend/Gdata</code> Verzeichnis vorhanden.
  199. Dieses Beispiel läuft von der Kommandozeile aus, aber die enthaltenen Methoden sind
  200. einfach in einem Web Anwendung zu portieren.
  201. </para>
  202. </sect2>
  203. <sect2 id="zend.gdata.introduction.magicfactory">
  204. <title>Instanzen von Zend_Gdata Klassen erhalten</title>
  205. <para>
  206. Der Zend Framework Namensstandard erzwingt das alle Klassen nach der Verzeichnis
  207. Struktur benannt werden in welcher sie vorhanden sind. Zum Beispiel eine Erweiterung die
  208. zu Tabellenkalkulation gehört und in <code>Zend/Gdata/Spreadsheets/Extension/...</code>
  209. gespeichert ist, muß als Ergebnis
  210. <classname>Zend_Gdata_Spreadsheets_Extension_...</classname> benannt werden. Das
  211. verursacht eine Menge an Tipparbeit wenn versucht wird eine neue Instanz eines Zellen
  212. Elements zu erstellen!
  213. </para>
  214. <para>
  215. Wir haben eine magische Fabriksmethode in alle Service Klassen (wie
  216. <classname>Zend_Gdata_App</classname>, <classname>Zend_Gdata</classname>,
  217. <classname>Zend_Gdata_Spreadsheets</classname>) implementiert welche die Erstellung
  218. neuer Instanzen von Daten Modellen, Abfragen und anderen Klassen viel einfacher macht.
  219. Diese magische Fabriksmethode ist durch die Verwendung der magischen <code>__call</code>
  220. Methode implementiert um auf alle Versuche
  221. <code>$service->newXXX(arg1, arg2, ...)</code> aufzurufen, angewendet zu werden.
  222. Basieren auf dem Wert von XXX, wird eine Suche in allen registrierten 'Paketen', für die
  223. gewünschte Klasse, durchgeführt. Hier sind einige Beispiele:
  224. </para>
  225. <programlisting language="php"><![CDATA[
  226. $ss = new Zend_Gdata_Spreadsheets();
  227. // Erstellt ein Zend_Gdata_App_Spreadsheets_CellEntry
  228. $entry = $ss->newCellEntry();
  229. // Erstellt ein Zend_Gdata_App_Spreadsheets_Extension_Cell
  230. $cell = $ss->newCell();
  231. $cell->setText('Mein Zellenwert');
  232. $cell->setRow('1');
  233. $cell->setColumn('3');
  234. $entry->cell = $cell;
  235. // ... $entry kann dann verwendet werden um eine Aktualisierung
  236. // an eine Google Tabellenkalkulation zu senden
  237. ]]></programlisting>
  238. <para>
  239. Jede Service Klasse im abgeleiteten Baum ist dafür verantwortlich das die richtigen
  240. 'Pakete' (Verzeichnisse) registriert werden, in welchen dann durch den Aufruf der
  241. matischen Fabriksmethode, gesucht wird.
  242. </para>
  243. </sect2>
  244. <sect2 id="zend.gdata.introduction.authentication">
  245. <title>Google Data Client Authentifizierung</title>
  246. <para>
  247. Die meisten Google Daten Services erfordern das sich die Client Anwendung auf dem Google
  248. Server authentifiziert bevor auf private Daten zugegriffen, oder Daten gespeichert oder
  249. gelöscht werden können. Es gibt zwei Implementationen der Authentifizierung für Google
  250. Daten: <link linkend="zend.gdata.authsub">AuthSub</link> und <link
  251. linkend="zend.gdata.clientlogin">ClientLogin</link>.
  252. <classname>Zend_Gdata</classname> bietet Klassen Interfaces für beide dieser Methoden.
  253. </para>
  254. <para>
  255. Die meisten anderen Typen von Abfragen auf Google Daten Servicen benötigen keine
  256. Authentifizierung.
  257. </para>
  258. </sect2>
  259. <sect2 id="zend.gdata.introduction.dependencies">
  260. <title>Abhängigkeiten</title>
  261. <para>
  262. <classname>Zend_Gdata</classname> verwendet <link
  263. linkend="zend.http.client">Zend_Http_Client</link> um Anfragen an
  264. google.com zu senden und Ergebnisse zu erhalten. Die Antworter der meisten Google Data
  265. Anfragen werden als Subklasse von <classname>Zend_Gdata_App_Feed</classname> oder
  266. <classname>Zend_Gdata_App_Entry</classname> Klassen zurückgegeben.
  267. </para>
  268. <para>
  269. <classname>Zend_Gdata</classname> nimmt an das die PHP Anwendung auf einem Host läuft
  270. der eine direkte Verbindung zum Internet hat. Der <classname>Zend_Gdata</classname>
  271. Client arbeitet indem er zu Google Daten Servern Kontakt aufnimmt.
  272. </para>
  273. </sect2>
  274. <sect2 id="zend.gdata.introduction.creation">
  275. <title>Erstellen eines neuen Gdata Klienten</title>
  276. <para>
  277. Man muß ein neues Objekt der Klasse <classname>Zend_Gdata_App</classname>,
  278. <classname>Zend_Gdata</classname>, oder einer dessen Subklassen erstellen die Helfer
  279. Methoden für servicespezifische Verhaltensweisen anbieten.
  280. </para>
  281. <para>
  282. Der einzige optionale Parameter für den Konstruktor von
  283. <classname>Zend_Gdata_App</classname> ist eine Instanz von
  284. <link linkend="zend.http.client">Zend_Http_Client</link>. Wenn dieser Parameter nicht
  285. übergeben wird, erstellt <classname>Zend_Gdata</classname> ein standardmäßiges
  286. <classname>Zend_Http_Client</classname> Objekt, welches keine Zugangsdaten zugeordnet
  287. hat um auf private Feeds zugreifen zu können. Die Spezifizierung des
  288. <classname>Zend_Http_Client</classname> Objektes erlaubt es auch Konfigurationsoptionen
  289. an das Client Objekt zu übergeben.
  290. </para>
  291. <programlisting language="php"><![CDATA[
  292. $client = new Zend_Http_Client();
  293. $client->setConfig( ...options... );
  294. $gdata = new Zend_Gdata($client);
  295. ]]></programlisting>
  296. <para>
  297. Beginnend mit Zend Framework 1.7, wurde die Unterstützung für die Versionierung des
  298. Protkolls hinzugefügt. Das erlaut dem Client und Server neue Fesatures zu unterstützen,
  299. wärend die Rückwärts Kompatibilität gewahrt bleibt. Wärend die meisten Services das für
  300. dich selbst durchführen, wenn man eine <classname>Zend_Gdata</classname> Instanz direkt
  301. erstellt (als Gegensatz zu einer Ihrer Unterklassen), kann es sein das man die
  302. gewünschte Version des Protokolls spezifizieren will um auf spezielle
  303. Serverfunktionalitäten zugreifen zu können.
  304. </para>
  305. <programlisting language="php"><![CDATA[
  306. $client = new Zend_Http_Client();
  307. $client->setConfig( ...options... );
  308. $gdata = new Zend_Gdata($client);
  309. $gdata->setMajorProtocolVersion(2);
  310. $gdata->setMinorProtocolVersion(null);
  311. ]]></programlisting>
  312. <para>
  313. Siehe auch die Sektion über Authentifizierung für Methoden, um ein authentifiziertes
  314. <classname>Zend_Http_Client</classname> Objekt zu erstellen.
  315. </para>
  316. </sect2>
  317. <sect2 id="zend.gdata.introduction.parameters">
  318. <title>Übliche Abfrage Parameter</title>
  319. <para>
  320. Es können Parameter spezifiziert werden um Abfragen mit
  321. <classname>Zend_Gdata</classname> anzupassen. Abfrageparameter werden spezifiziert indem
  322. Subklassen von <classname>Zend_Gdata_Query</classname> verwendet werden. Die
  323. <classname>Zend_Gdata_Query</classname> Klasse beinhaltet Methoden um alle
  324. Abfrageparameter zu setzen die von Gdata Services verwendet werden. Individuelle
  325. Services, wie Tabellenkalkulationen, bieten auch Abfrageklassen zu definierten
  326. Parametern welche an das spezielle Service und die Feeds angepasst sind.
  327. Tabellenkalkulationen beinhalten eine CellQuery Klasse um den Zellen Feed abzufragen und
  328. eine ListQuery Klasse um den Listen Feed abzufragen, da verschiedene Abfrageparameter
  329. für jeder dieser Feedtypen möglich sind. Die GData-weiten Parameter werden anbei
  330. beschrieben.
  331. </para>
  332. <itemizedlist>
  333. <listitem>
  334. <para>
  335. Der <code>q</code> Parameter spezifiziert eine komplette Textabfrage. Der Wert
  336. dieses Parameters ist ein String.
  337. </para>
  338. <para>
  339. Dieser Parameter kann mit der <code>setQuery()</code> Methode gesetzt werden.
  340. </para>
  341. </listitem>
  342. <listitem>
  343. <para>
  344. Der <code>alt</code> Parameter spezifiziert den Feed Typ. Der Wert dieses
  345. Parameters kann <code>atom</code>, <code>rss</code>, <code>json</code>, oder
  346. <code>json-in-script</code> sein. Wenn dieser Parameter nicht spezifiziert wird,
  347. ist der Standard Feedtyp <code>atom</code>.
  348. <classname>Zend_Http_Client</classname> könnte verwendet werden um Feeds in
  349. anderen Formaten zu empfangen, indem die von der
  350. <classname>Zend_Gdata_Query</classname> Klasse oder deren Subklassen erzeugten
  351. Abfrage URLs verwendet werden.
  352. </para>
  353. <para>
  354. Dieser Parameter kann mit der <code>setAlt()</code> Methode gesetzt werden.
  355. </para>
  356. </listitem>
  357. <listitem>
  358. <para>
  359. Der <code>maxResults</code> Parameter begrenzt die Anzahl an Einträgen im Feed.
  360. Der Wert dieses Parameters ist ein Integer. Die zurückgegebene Anzahl an
  361. Einträgen im Feed wird diesen Wert nicht überschreiten.
  362. </para>
  363. <para>
  364. Dieser Parameter kann mit der <code>setMaxResults()</code> Methode gesetzt
  365. werden.
  366. </para>
  367. </listitem>
  368. <listitem>
  369. <para>
  370. Der <code>startIndex</code> Parameter spezifiziert die ordinale Nummer des
  371. ersten Eintrags der im Feed zurückgegeben wird. Einträge vor dieser Nummer
  372. werden übergangen.
  373. </para>
  374. <para>
  375. Dieser Parameter kann mit der <code>setStartIndex()</code> Methode gesetzt
  376. werden.
  377. </para>
  378. </listitem>
  379. <listitem>
  380. <para>
  381. Die Parameter <code>updatedMin</code> und <code>updatedMax</code> spezifizieren
  382. Grenzen für das Datum der Einträge. Wenn ein Wert für <code>updatedMin</code>
  383. spezifiziert wird, werden keine Einträge die vor dem spezifizierten Datum
  384. aktualisiert wurden, im Feed inkludiert. Genauso werden keine Einträge
  385. inkludiert die nach einem Datum aktualisiert wurden wenn <code>updatedMax</code>
  386. spezifiziert wird.
  387. </para>
  388. <para>
  389. Es können nummerische Zeitstempel, oder eine Variation von Datum/Zeit String
  390. Repräsentationen als Wert für diese Parameter verwendet werden.
  391. </para>
  392. <para>
  393. Diese Parameter kkönnen mit den <code>setUpdatedMin()</code> und
  394. <code>setUpdatedMax()</code> Methoden gesetzt werden.
  395. </para>
  396. </listitem>
  397. </itemizedlist>
  398. <para>
  399. Es gibt eine <code>get</code> Funktion für jede <code>set</code> Funktion.
  400. </para>
  401. <programlisting language="php"><![CDATA[
  402. $query = new Zend_Gdata_Query();
  403. $query->setMaxResults(10);
  404. echo $query->getMaxResults(); // gibt 10 zurück
  405. ]]></programlisting>
  406. <para>
  407. Die <classname>Zend_Gdata</classname> Klasse implementiert auch "magische" Getter und
  408. Setter Methoden, es kann also der Name des Parameters als virtuelles Mitglied der Klasse
  409. verwendet werden.
  410. </para>
  411. <programlisting language="php"><![CDATA[
  412. $query = new Zend_Gdata_Query();
  413. $query->maxResults = 10;
  414. echo $query->maxResults; // gibt 10 zurück
  415. ]]></programlisting>
  416. <para>
  417. Es können alle Parameter mit der <code>resetParameters()</code> Funktion gelöscht
  418. werden. Das ist nützlich wenn ein <classname>Zend_Gdata</classname> Objekt für mehrfache
  419. Abfragen wiederverwendet werden soll.
  420. </para>
  421. <programlisting language="php"><![CDATA[
  422. $query = new Zend_Gdata_Query();
  423. $query->maxResults = 10;
  424. // ...den Feed empfangen...
  425. $query->resetParameters(); // löscht alle Parameter
  426. // ...einen anderen Feed empfangen...
  427. ]]></programlisting>
  428. </sect2>
  429. <sect2 id="zend.gdata.introduction.getfeed">
  430. <title>Einen Feed empfangen</title>
  431. <para>
  432. Die <code>getFeed()</code> Funktion kann verwendet werden um einen Feed von einer
  433. spezifizierten URI zu empfangen. Diese Funktion gibt eine Instanz der Klasse, die als
  434. zweites Argument an getFeed übergeben wurde, zurück, welche standardmäßig
  435. Zend_Gdata_Feed ist.
  436. </para>
  437. <programlisting language="php"><![CDATA[
  438. $gdata = new Zend_Gdata();
  439. $query = new Zend_Gdata_Query(
  440. 'http://www.blogger.com/feeds/blogID/posts/default');
  441. $query->setMaxResults(10);
  442. $feed = $gdata->getFeed($query);
  443. ]]></programlisting>
  444. <para>
  445. Siehe spätere Sektionen für spezielle Funktionen in jeder Helfer Klasse für Google Daten
  446. Services. Diese Funktionen helfen Feeds von einer URI zu empfangen die für das
  447. angeforderte Service zuständig ist.
  448. </para>
  449. </sect2>
  450. <sect2 id="zend.gdata.introduction.paging">
  451. <title>Mit Mehrfach-Seiten Feeds arbeiten</title>
  452. <para>
  453. Wenn man einen Feed empfängt der eine große Anzahl an Einträgen enthält, kann dieser
  454. Feed in viele kleinere "Seiten" von Feeds gebrochen werden. Wenn das passiert, enthält
  455. jede Seite einen Link zur nächsten Seite der Serie. Auf diesen Link kann mit Hilfe von
  456. <code>getLink('next')</code> zugegriffen werden. Das folgende Beispiel zeigt wie auf die
  457. nächste Seite eines Feeds empfangen werden kann:
  458. </para>
  459. <programlisting language="php"><![CDATA[
  460. function getNextPage($feed) {
  461. $nextURL = $feed->getLink('next');
  462. if ($nextURL !== null) {
  463. return $gdata->getFeed($nextURL);
  464. } else {
  465. return null;
  466. }
  467. }
  468. ]]></programlisting>
  469. <para>
  470. Wenn man es vorzieht nicht mit Seiten in der eigenen Anwendung zu arbeiten, kann die
  471. erste Seite des Feeds an
  472. <classname>Zend_Gdata_App::retrieveAllEntriesForFeed()</classname> übergeben werden,
  473. welche alle Einträge von jeder Seite in einen einzelnen Feed zusammenfasst. Dieses
  474. Beispiel zeigt wie diese Funktion verwendet werden kann:
  475. </para>
  476. <programlisting language="php"><![CDATA[
  477. $gdata = new Zend_Gdata();
  478. $query = new Zend_Gdata_Query(
  479. 'http://www.blogger.com/feeds/blogID/posts/default');
  480. $feed = $gdata->retrieveAllEntriesForFeed($gdata->getFeed($query));
  481. ]]></programlisting>
  482. <para>
  483. Es gilt zu beachten das wenn diese Funktion aufgerufen wird, dies eine sehr lange Zeit
  484. benötigen kann im große Feeds zu komplettieren. Es kann notwendig sein PHP's Limit der
  485. Ausführungszeit zu vergrößern mithilfe von <code>set_time_limit()</code> zu vergrößern.
  486. </para>
  487. </sect2>
  488. <sect2 id="zend.gdata.introduction.usefeedentry">
  489. <title>Arbeiten mit Daten in Feeds und Einträgen</title>
  490. <para>
  491. Nachdem ein Feed empfangen wurde, können die Daten von dem Feed oder den Einträgen die
  492. in dem Feed enthalten sind, gelesen werden, indem entweder die in jeder Daten Modell
  493. Klasse definierten Zugriffsmethoden oder die magischen Zugriffsmethoden verwendet
  494. werden. Hier ist ein Beispiel:
  495. </para>
  496. <programlisting language="php"><![CDATA[
  497. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  498. $gdata = new Zend_Gdata($client);
  499. $query = new Zend_Gdata_Query(
  500. 'http://www.blogger.com/feeds/blogID/posts/default');
  501. $query->setMaxResults(10);
  502. $feed = $gdata->getFeed($query);
  503. foreach ($feed as $entry) {
  504. // Die magischen Zugriffsmethoden verwenden
  505. echo 'Titel: ' . $entry->title->text;
  506. // Die definierten Zugriffsmethoden verwenden
  507. echo 'Inhalt: ' . $entry->getContent()->getText();
  508. }
  509. ]]></programlisting>
  510. </sect2>
  511. <sect2 id="zend.gdata.introduction.updateentry">
  512. <title>Einträge aktualisieren</title>
  513. <para>
  514. Nachdem ein Eintrag empfangen wurde, kann dieser Eintrag aktualisiert und die Änderungen
  515. an den Server zurück gespeichert werden. Hier ist ein Beispiel:
  516. </para>
  517. <programlisting language="php"><![CDATA[
  518. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  519. $gdata = new Zend_Gdata($client);
  520. $query = new Zend_Gdata_Query(
  521. 'http://www.blogger.com/feeds/blogID/posts/default');
  522. $query->setMaxResults(10);
  523. $feed = $gdata->getFeed($query);
  524. foreach ($feed as $entry) {
  525. // Dem Titel 'NEU' hinzufügen
  526. echo 'Alter Titel: ' . $entry->title->text;
  527. $entry->title->text = $entry->title->text . ' NEU';
  528. // Den Eintrag auf dem Server aktualisieren
  529. $newEntry = $entry->save();
  530. echo 'New Title: ' . $newEntry->title->text;
  531. }
  532. ]]></programlisting>
  533. </sect2>
  534. <sect2 id="zend.gdata.introduction.post">
  535. <title>Einträge an Google Server schicken</title>
  536. <para>
  537. The <classname>Zend_Gdata</classname> object has a function <code>insertEntry()</code>
  538. with which you can upload data to save new entries
  539. to Google Data services.
  540. </para>
  541. <para>
  542. Die Daten Modell Klassen jedes Services kann verwendet werden um einen entsprechenden
  543. Eintrag zu erstellen und an Google's Services zu schicken. Die
  544. <code>insertEntry()</code> Funktion akzeptiert ein Kind von
  545. <classname>Zend_Gdata_App_Entry</classname> als Daten die an den Service geschickt
  546. werden. Die Methode gibt ein Kind von <classname>Zend_Gdata_App_Entry</classname> zurück
  547. welches den Status des Eintrages repräsentiert der vom Server zurückgegeben wurde.
  548. </para>
  549. <para>
  550. Alternativ, kann die XML Struktur eines Eintrages als String konstruiert und dieser
  551. String an die <code>insertEntry()</code> Funktion übergeben werden.
  552. </para>
  553. <programlisting language="php"><![CDATA[
  554. $gdata = new Zend_Gdata($authenticatedHttpClient);
  555. $entry = $gdata->newEntry();
  556. $entry->title = $gdata->newTitle('Füßball im Park spielen');
  557. $content =
  558. $gdata->newContent('Wir besuchen den Part und spielen Fußball');
  559. $content->setType('text');
  560. $entry->content = $content;
  561. $entryResult = $gdata->insertEntry($entry,
  562. 'http://www.blogger.com/feeds/blogID/posts/default');
  563. echo 'Die <id> des resultierenden Eintrages ist: ' . $entryResult->id->text;
  564. ]]></programlisting>
  565. <para>
  566. Um Einträge zu senden, muß ein authentifizierter <classname>Zend_Http_Client</classname>
  567. verwendet werden der mit Hilfe der <classname>Zend_Gdata_AuthSub</classname> oder
  568. <classname>Zend_Gdata_ClientLogin</classname> Klassen erstellt wurde.
  569. </para>
  570. </sect2>
  571. <sect2 id="zend.gdata.introduction.delete">
  572. <title>Einträge auf einem Google Server löschen</title>
  573. <para>
  574. Option 1: Das <classname>Zend_Gdata</classname> Objekt hat eine <code>delete()</code>
  575. Funktion mit der Einträge von Google Daten Services gelöscht werden können. Der
  576. bearbeitete URL Wert eines Feed Eintrages kann der <code>delete()</code> Methode
  577. übergeben werden.
  578. </para>
  579. <para>
  580. Option 2: Alternativ kann <code>$entry->delete()</code> an einem Eintrag der von einem
  581. Google Service empfangen wurde, aufgerufen werden.
  582. </para>
  583. <programlisting language="php"><![CDATA[
  584. $gdata = new Zend_Gdata($authenticatedHttpClient);
  585. // ein Google Daten Feed
  586. $feedUri = ...;
  587. $feed = $gdata->getFeed($feedUri);
  588. foreach ($feed as $feedEntry) {
  589. // Option 1 - den Eintrag direkt löschen
  590. $feedEntry->delete();
  591. // Option 2 - den eintrag durch Übergabe der bearbeiteten URL an
  592. // $gdata->delete() löschen
  593. // $gdata->delete($feedEntry->getEditLink()->href);
  594. }
  595. ]]></programlisting>
  596. <para>
  597. Um Einträge zu löschen, muß ein authentifizierter
  598. <classname>Zend_Http_Client</classname> verwendet werden der mit Hilfe der
  599. <classname>Zend_Gdata_AuthSub</classname> oder
  600. <classname>Zend_Gdata_ClientLogin</classname> Klassen erstellt wurde.
  601. </para>
  602. </sect2>
  603. </sect1>