Zend_Gdata-Introduction.xml 32 KB

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