Zend_Gdata-Introduction.xml 32 KB

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