Zend_Gdata-Introduction.xml 33 KB

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