Zend_Gdata_Spreadsheets.xml 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 20779 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.gdata.spreadsheets">
  5. <title>Google Tabellenkalkulation verwenden</title>
  6. <para>
  7. Die Google Tabellenkalkulations Daten <acronym>API</acronym> erlaubt es Client Anwendungen
  8. Inhalte von Tabellenkalkulationen zu sehen und Inhalte von Tabellenkalkulationen in der form
  9. von Google Daten <acronym>API</acronym> Feeds zu aktualisieren. Die eigene Client Anwendung
  10. kann eine Liste von Tabellenkalkulationen eines Benutzer anfragen, Inhalte eines bestehenden
  11. Arbeitsblatts der Tabellenkalkulation bearbeiten oder löschen, und den Inhalt eines
  12. bestehenden Arbeitsblatt der Tabellenkalkulation abfragen.
  13. </para>
  14. <para>
  15. Siehe <ulink
  16. url="http://code.google.com/apis/spreadsheets/overview.html">http://code.google.com/apis/spreadsheets/overview.html</ulink>
  17. für weitere Informationen über die Google's Tabellenkalkulations <acronym>API</acronym>.
  18. </para>
  19. <sect2 id="zend.gdata.spreadsheets.creating">
  20. <title>Eine Tabellenkalkulation erstellen</title>
  21. <para>
  22. Die Tabellenkalkulations Daten <acronym>API</acronym> bietet aktuell noch keinen Weg um
  23. eine Tabellenkalkulation programmtechnisch zu erstellen oder zu löschen.
  24. </para>
  25. </sect2>
  26. <sect2 id="zend.gdata.spreadsheets.listspreadsheets">
  27. <title>Eine Liste von Tabellenkalkulationen erhalten</title>
  28. <para>
  29. Man kann eine Liste von Tabellenkalkulationen für einen bestimmten Benutzer erhalten
  30. indem die <code>getSpreadsheetFeed</code> Methode des Tabellenkalkulationsservices
  31. verwendet wird. Der Service wird ein
  32. <classname>Zend_Gdata_Spreadsheets_SpreadsheetFeed</classname> Objekt zurückgeben das
  33. eine Liste von Tabellenkalkulationen enthält die mit dem authentifizierten Benutzer
  34. authentifiziert sind.
  35. </para>
  36. <programlisting language="php"><![CDATA[
  37. $service = Zend_Gdata_Spreadsheets::AUTH_SERVICE_NAME;
  38. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
  39. $spreadsheetService = new Zend_Gdata_Spreadsheets($client);
  40. $feed = $spreadsheetService->getSpreadsheetFeed();
  41. ]]></programlisting>
  42. </sect2>
  43. <sect2 id="zend.gdata.spreadsheets.listworksheets">
  44. <title>Eine Liste von Arbeitsblättern erhalten</title>
  45. <para>
  46. Eine gegebene Tabellenkalkulation kann mehrere Arbeitsblätter enthalten. Für jedes
  47. Arbeitsblass gibt es einen Arbeitsblatt Metafeed der alle Arbeitsblätter in dieser
  48. Tabellenkalkulation auflistet.
  49. </para>
  50. <para>
  51. Mit der Schlüssel der Tabellenkalkulation von der &lt;id&gt; des
  52. <classname>Zend_Gdata_Spreadsheets_SpreadsheetEntry</classname> Objekts das man bereits
  53. empfangen hat, kann mein einen Feed holen der eine Liste von Arbeitsblättern enthält die
  54. mit dieser Tabellenkalkulation assoziiert sind.
  55. </para>
  56. <programlisting language="php"><![CDATA[
  57. $query = new Zend_Gdata_Spreadsheets_DocumentQuery();
  58. $query->setSpreadsheetKey($spreadsheetKey);
  59. $feed = $spreadsheetService->getWorksheetFeed($query);
  60. ]]></programlisting>
  61. <para>
  62. Der sich ergebende <classname>Zend_Gdata_Spreadsheets_WorksheetFeed</classname>
  63. Objektfeed repräsentiert die Antwort des Servers. Neben anderen Dingen enthält dieser
  64. Feed eine Liste von <classname>Zend_Gdata_Spreadsheets_WorksheetEntry </classname>
  65. Objekten (<code>$feed->entries</code>), wobei jedes ein einzelnes Arbeitsblatt
  66. repräsentiert.
  67. </para>
  68. </sect2>
  69. <sect2 id="zend.gdata.spreadsheets.listfeeds">
  70. <title>Mit listen-basierenden Feeds interagieren</title>
  71. <para>
  72. Ein gegebenes Arbeitsblatt enthält generell mehrere Zeilen, wobei jede mehrere Zellen
  73. enthält. Man kann Daten vom Arbeitsblatt entweder als listen-basierenden Feed anfragen,
  74. in dem jeder Eintrag eine Zeile repräsentiert, oder als zellen-basierenden Feed, in dem
  75. jeder Eintrag eine einzelne Zelle repräsentiert. Für Informationen über
  76. zellen-basierende Feeds kann auch unter <link
  77. linkend="zend.gdata.spreadsheets.cellfeeds">Interaktion mit zellen-basierenden
  78. Feeds</link> nachgesehen werden.
  79. </para>
  80. <para>
  81. Die folgenden Sektionen beschreiben wie man einen Listen basierender Feed erhält, eine
  82. Zeile zu einem Arbeitsblatt hinzufügt, und Abfragen mit verschiedenen Abfrage Parametern
  83. sendet.
  84. </para>
  85. <para>
  86. Der Listenfeed macht einige Annahmen darüber wie die Daten in der Tabellenkalkulation
  87. ausgelegt sind.
  88. </para>
  89. <para>
  90. Im speziellen, behandelt der Listenfeed die erste Zeile des Arbeitsblattes als
  91. Kopfzeile; Tabellenkalkulationen erstellen dynamisch <acronym>XML</acronym> Elemente
  92. welche nach dem Inhalt der Kopfzeilen-Zellen benannt sind. Benutzer welche Gdata Feeds
  93. anbieten wollen, sollten keine andere Daten als Spaltenheader in der ersten Zeile eines
  94. Arbeitsblattes ablegen.
  95. </para>
  96. <para>
  97. Der Listenfeed enthält alle Zeilen nach der ersten Zeile bis zur ersten leeren Zeile.
  98. Die erste leere Zeile terminiert das Datenset. Wenn angenommene Daten nicht in einem
  99. Feed erscheinen, muß das Arbeitsblatt manuell darauf geprüft werden ob eine unerwartete
  100. leere Zeile in der Mitte der Daten vorhanden ist. Im speziellen wird der Listenfeed,
  101. wenn die zweite Zeile der Tabellenkalkulation leer ist, keine Daten enthalten.
  102. </para>
  103. <para>
  104. Eine Zeile in einem Listenfeed ist soviele Spalten breit wie das Arbeitsblatt selbst.
  105. </para>
  106. <sect3 id="zend.gdata.spreadsheets.listfeeds.get">
  107. <title>Einen listen-basierenden Feed erhalten</title>
  108. <para>
  109. Um einen Listenfeed eines Arbeitsblattes zu erhalten, kann die
  110. <code>getListFeed</code> Methode des Tabellenkalkulations Services verwendet werden.
  111. </para>
  112. <programlisting language="php"><![CDATA[
  113. $query = new Zend_Gdata_Spreadsheets_ListQuery();
  114. $query->setSpreadsheetKey($spreadsheetKey);
  115. $query->setWorksheetId($worksheetId);
  116. $listFeed = $spreadsheetService->getListFeed($query);
  117. ]]></programlisting>
  118. <para>
  119. Das sich ergebende <classname>Zend_Gdata_Spreadsheets_ListFeed</classname> Objekt
  120. <varname>$listfeed</varname> repräsentiert eine Antwort vom Server. Neben anderen
  121. Dingen enthält dieser Feed ein Array von
  122. <classname>Zend_Gdata_Spreadsheets_ListEntry</classname> Objekten
  123. (<code>$listFeed->entries</code>), wobei jedes eine einzelne Zeile in einem
  124. Arbeitsblatt repräsentiert.
  125. </para>
  126. <para>
  127. Jeder <classname>Zend_Gdata_Spreadsheets_ListEntry</classname> enthält ein Array,
  128. <code>custom</code>, welches die Daten für die Zeile enthält. Dieses Array kann
  129. extrahiert und angezeigt werden:
  130. </para>
  131. <programlisting language="php"><![CDATA[
  132. $rowData = $listFeed->entries[1]->getCustom();
  133. foreach($rowData as $customEntry) {
  134. echo $customEntry->getColumnName() . " = " . $customEntry->getText();
  135. }
  136. ]]></programlisting>
  137. <para>
  138. Eine alternative Version dieses Arrays, <code>customByName</code>, erlaubt den
  139. direkten Zugriff zu dem Eintrag einer Zelle durch den Namen. Das ist üblich, wenn
  140. man versucht auf einen speziellen Header zuzugreifen:
  141. </para>
  142. <programlisting language="php"><![CDATA[
  143. $customEntry = $listFeed->entries[1]->getCustomByName('my_heading');
  144. echo $customEntry->getColumnName() . " = " . $customEntry->getText();
  145. ]]></programlisting>
  146. </sect3>
  147. <sect3 id="zend.gdata.spreadsheets.listfeeds.reverse">
  148. <title>Umgekehrt-sortierte Zeilen</title>
  149. <para>
  150. Standardmäßig werden die Zeilen im Feed in der gleichen Reihenfolge angezeigt wie in
  151. den entsprechenden Zeilen im GUI; das ist die Reihenfolge anhand der Zeilennummer.
  152. Um Zeilen in einer umgekehrten Reihenfolge zu erhalten, muß die reverse Eigenschaft
  153. des <classname>Zend_Gdata_Spreadsheets_ListQuery</classname> Objektes auf
  154. <constant>TRUE</constant> gesetzt werden:
  155. </para>
  156. <programlisting language="php"><![CDATA[
  157. $query = new Zend_Gdata_Spreadsheets_ListQuery();
  158. $query->setSpreadsheetKey($spreadsheetKey);
  159. $query->setWorksheetId($worksheetId);
  160. $query->setReverse('true');
  161. $listFeed = $spreadsheetService->getListFeed($query);
  162. ]]></programlisting>
  163. <para>
  164. Es ist zu beachten, das wenn nach einer speziellen Spalte sortiert (oder umgekehrt
  165. sortiert) werden soll, statt nach der Position im Arbeitsblatt, kann der
  166. <code>orderby</code> Wert des
  167. <classname>Zend_Gdata_Spreadsheets_ListQuery</classname> Objekts auf
  168. <code>column:&lt;Der Header dieser Spalte&gt;</code> gesetzt werden.
  169. </para>
  170. </sect3>
  171. <sect3 id="zend.gdata.spreadsheets.listfeeds.sq">
  172. <title>Eine strukturierte Abfrage senden</title>
  173. <para>
  174. Der <code>sq</code> Wert von
  175. <classname>Zend_Gdata_Spreadsheets_ListQuery</classname> kann gesetzt werden um
  176. einen Feed mit Einträgen zu erzeugen die ein spezielles Kriterium erfüllen.
  177. Angenommen, man hat ein Arbeitsblatt das personelle Daten enthält, in denen jede
  178. Zeile Informationen über eine einzelne Person repräsentiert, und man will alle
  179. Zeilen empfangen will in denen der Name der Person "John" ist, und das Alter der
  180. Person über 25. Um das tu tun, muß <code>sq</code> wie folgt gesetzt werden:
  181. </para>
  182. <programlisting language="php"><![CDATA[
  183. $query = new Zend_Gdata_Spreadsheets_ListQuery();
  184. $query->setSpreadsheetKey($spreadsheetKey);
  185. $query->setWorksheetId($worksheetId);
  186. $query->setSpreadsheetQuery('name=John and age>25');
  187. $listFeed = $spreadsheetService->getListFeed($query);
  188. ]]></programlisting>
  189. </sect3>
  190. <sect3 id="zend.gdata.spreadsheets.listfeeds.addrow">
  191. <title>Hinzufügen einer Zeile</title>
  192. <para>
  193. Zeilen können zu einer Tabellenkalkulation hinzugefügt werden durch Verendung der
  194. <code>insertRow</code> Methode des Tabellenkalkulations Services.
  195. </para>
  196. <programlisting language="php"><![CDATA[
  197. $insertedListEntry = $spreadsheetService->insertRow($rowData,
  198. $spreadsheetKey,
  199. $worksheetId);
  200. ]]></programlisting>
  201. <para>
  202. Der <varname>$rowData</varname> Parameter enthält ein Array von Spaltenschlüssel zu
  203. Datenwerten. Die Methode gibt ein
  204. <classname>Zend_Gdata_Spreadsheets_SpreadsheetsEntry</classname> Objekt zurück
  205. welches die eingefügte Zeile repräsentiert.
  206. </para>
  207. <para>
  208. Die Tabellenkalkulation fügt die neue Zeile unmittelbar nach der letzten Zeile ein
  209. die in dem listen-basierenden Feed erscheint, was bedeutet unmittelbar vor der
  210. ersten komplett leeren Zeile.
  211. </para>
  212. </sect3>
  213. <sect3 id="zend.gdata.spreadsheets.listfeeds.editrow">
  214. <title>Eine Zeile bearbeiten</title>
  215. <para>
  216. Sobald ein <classname>Zend_Gdata_Spreadsheets_ListEntry</classname> Objekt geholt
  217. wird, können diese Zeilen durch die Verwendung der <code>updateRow</code> Methode
  218. des Tabellenkalkulations Services aktualisiert werden.
  219. </para>
  220. <programlisting language="php"><![CDATA[
  221. $updatedListEntry = $spreadsheetService->updateRow($oldListEntry,
  222. $newRowData);
  223. ]]></programlisting>
  224. <para>
  225. Der <varname>$oldListEntry</varname> Parameter enthält den Listeneintrag der
  226. aktualisiert werden soll. <varname>$newRowData</varname> enthält ein Array von
  227. Spaltenschlüssel zu Datenwerten, die als neue Zeilendaten verwendet werden. Diese
  228. Methode gibt ein <classname>Zend_Gdata_Spreadsheets_SpreadsheetsEntry</classname>
  229. Objekt zurück welches die aktualisierte Zeile repräsentiert.
  230. </para>
  231. </sect3>
  232. <sect3 id="zend.gdata.spreadsheets.listfeeds.deleterow">
  233. <title>Eine Zeile löschen</title>
  234. <para>
  235. Um eine Zeile zu löschen muß einfach <code>deleteRow</code> auf dem
  236. <classname>Zend_Gdata_Spreadsheets</classname> Objekt mit dem bestehenden Eintrag
  237. aufgerufen werden, der gelöscht werden soll:
  238. </para>
  239. <programlisting language="php"><![CDATA[
  240. $spreadsheetService->deleteRow($listEntry);
  241. ]]></programlisting>
  242. <para>
  243. Alternativ kann die <code>delete</code> Methode des Eintrags selbst aufgerufen
  244. werden:
  245. </para>
  246. <programlisting language="php"><![CDATA[
  247. $listEntry->delete();
  248. ]]></programlisting>
  249. </sect3>
  250. </sect2>
  251. <sect2 id="zend.gdata.spreadsheets.cellfeeds">
  252. <title>Mit zellen-basierenden Feeds interagieren</title>
  253. <para>
  254. In einem zellen-basierenden Feed repräsentiert jeder Eintrag eine einzelne Zelle.
  255. </para>
  256. <para>
  257. Es wird nicht empfohlen mit beiden, einem zellen-basierenden Feed und einem
  258. listen-basierenden Feed für das gleiche Arbeitsblatt zur selben Zeit zu interagieren.
  259. </para>
  260. <sect3 id="zend.gdata.spreadsheets.cellfeeds.get">
  261. <title>Einen zellen-basierenden Feed erhalten</title>
  262. <para>
  263. Um einen Zellen Feed des Arbeitsblatt zu erhalten muß die <code>getCellFeed</code>
  264. Methode des Tabellenkalkulations Services verwendet werden.
  265. </para>
  266. <programlisting language="php"><![CDATA[
  267. $query = new Zend_Gdata_Spreadsheets_CellQuery();
  268. $query->setSpreadsheetKey($spreadsheetKey);
  269. $query->setWorksheetId($worksheetId);
  270. $cellFeed = $spreadsheetService->getCellFeed($query);
  271. ]]></programlisting>
  272. <para>
  273. Im resultierenden <classname>Zend_Gdata_Spreadsheets_CellFeed</classname> Objekt
  274. repräsentiert <varname>$cellFeed</varname> eine Antwort vom Server. Neben anderen
  275. Dingen enthält dieser Feed ein Array von
  276. <classname>Zend_Gdata_Spreadsheets_CellEntry</classname> Objekten
  277. (<code>$cellFeed>entries</code>), von denen jeder eine einzelne Zelle in einem
  278. Arbeitsblatt repräsentiert. Diese Information kann angezeigt werden:
  279. </para>
  280. <programlisting language="php"><![CDATA[
  281. foreach($cellFeed as $cellEntry) {
  282. $row = $cellEntry->cell->getRow();
  283. $col = $cellEntry->cell->getColumn();
  284. $val = $cellEntry->cell->getText();
  285. echo "$row, $col = $val\n";
  286. }
  287. ]]></programlisting>
  288. </sect3>
  289. <sect3 id="zend.gdata.spreadsheets.cellfeeds.cellrangequery">
  290. <title>Eine Zellen-Bereichs Abfrage senden</title>
  291. <para>
  292. Angenommen man will die Zellen der ersten Spalte des Arbeitsblattes empfangen. Man
  293. kann einen Zellen Feed abfragen der nur diese Spalte enthält und geht hierbei wie
  294. folgt vor:
  295. </para>
  296. <programlisting language="php"><![CDATA[
  297. $query = new Zend_Gdata_Spreadsheets_CellQuery();
  298. $query->setMinCol(1);
  299. $query->setMaxCol(1);
  300. $query->setMinRow(2);
  301. $feed = $spreadsheetService->getCellsFeed($query);
  302. ]]></programlisting>
  303. <para>
  304. Das fragt alle Daten in der Spalte 1, beginnend mit der Zeile 2, ab.
  305. </para>
  306. </sect3>
  307. <sect3 id="zend.gdata.spreadsheets.cellfeeds.updatecell">
  308. <title>Den Inhalt einer Zelle ändern</title>
  309. <para>
  310. Um den Inhalt einer Zelle zu ändern, muß <code>updateCell</code> mit der Zeile,
  311. Spalte und dem neuen Wert der Zelle, aufgerufen werden.
  312. </para>
  313. <programlisting language="php"><![CDATA[
  314. $updatedCell = $spreadsheetService->updateCell($row,
  315. $col,
  316. $inputValue,
  317. $spreadsheetKey,
  318. $worksheetId);
  319. ]]></programlisting>
  320. <para>
  321. Die neuen Daten werden in der spezifizierten Zelle im Arbeitsblatt plaziert. Wenn
  322. die spezifizierte Zelle bereits Daten enthält, werden diese überschrieben. Beachte:
  323. <code>updateCell</code> muß verwedet werden um Daten in einer Zelle zu verändern,
  324. selbst wenn diese Zelle leer ist.
  325. </para>
  326. </sect3>
  327. </sect2>
  328. </sect1>