Zend_Gdata_Spreadsheets.xml 17 KB

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