2
0

Zend_Db_Table_Rowset.xml 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 24249 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.db.table.rowset">
  5. <title>Zend_Db_Table_Rowset</title>
  6. <sect2 id="zend.db.table.rowset.introduction">
  7. <title>Einführung</title>
  8. <para>
  9. Wenn eine Datenbankabfrage über eine Tabellenklasse ausgeführt wird, genauer über deren
  10. Methoden <methodname>find()</methodname> und <methodname>fetchAll()</methodname>, wird
  11. das Ergebnis als Objekt vom Typ <classname>Zend_Db_Table_Rowset_Abstract</classname>
  12. zurückgegeben. Ein Zeilensatz enthält eine Sammlung von Objekten die von
  13. <classname>Zend_Db_Table_Row_Abstract</classname> abgeleitet sind. Man kann durch das
  14. Rowset iterieren und auf individuelle Zeilen Objekte zugreifen, sowie Daten in Zeilen
  15. lesen und modifizieren.
  16. </para>
  17. </sect2>
  18. <sect2 id="zend.db.table.rowset.fetch">
  19. <title>Einen Zeilensatz lesen</title>
  20. <para>
  21. <classname>Zend_Db_Table_Abstract</classname> bietet die Methoden
  22. <methodname>find()</methodname> und <methodname>fetchAll()</methodname>, die beide ein
  23. Objekt vom Typ <classname>Zend_Db_Table_Rowset_Abstract</classname> zurückgeben.
  24. </para>
  25. <example id="zend.db.table.rowset.fetch.example">
  26. <title>Einen Zeilensatz lesen</title>
  27. <programlisting language="php"><![CDATA[
  28. $bugs = new Bugs();
  29. $rowset = $bugs->fetchAll("bug_status = 'NEW'");
  30. ]]></programlisting>
  31. </example>
  32. </sect2>
  33. <sect2 id="zend.db.table.rowset.rows">
  34. <title>Zeilen aus einem Zeilensatz auslesen</title>
  35. <para>
  36. Der Zeilensatz selber ist normalerweise weniger interessant als die Zeilen, die er
  37. enthält. Dieser Abschnitt zeigt, wie die Zeilen, die im Zeilensatz enthalten sind,
  38. auslesbar sind.
  39. </para>
  40. <para>
  41. Eine normale Abfrage gibt null Zeilen zurück, wenn keine Zeilen in der Datenbank die
  42. Bedingungen der Abfrage erfüllt. Daher kann eine Zeilensatz-Objekt auch null
  43. Zeilenobjekte enthalten. Weil <classname>Zend_Db_Table_Rowset_Abstract</classname> auch
  44. das Interface <classname>Countable</classname> (dt.: Zählbar) implementiert, kann die
  45. Funktion <methodname>count()</methodname> genutzt werden, um die Anzahl der Zeilen im
  46. Zeilensatz zu erhalten.
  47. </para>
  48. <example id="zend.db.table.rowset.rows.counting.example">
  49. <title>Zeilen in einem Zeilensatz zählen</title>
  50. <programlisting language="php"><![CDATA[
  51. $rowset = $bugs->fetchAll("bug_status = 'FIXED'");
  52. $rowCount = count($rowset);
  53. if ($rowCount > 0) {
  54. echo "$rowCount Zeilen gefunden!";
  55. } else {
  56. echo 'keine Zeilen für die Abfrage gefunden.';
  57. }
  58. ]]></programlisting>
  59. </example>
  60. <example id="zend.db.table.rowset.rows.current.example">
  61. <title>Eine einzelne Zeile aus einem Zeilensatz auslesen</title>
  62. <para>
  63. Die einfachste Art, eine Zeile aus einem Zeilensatz auszulesen, ist die Methode
  64. <methodname>current()</methodname>. Diese ist vor allem dann nützlich, wenn der
  65. Zeilensatz genau eine Zeile enthält.
  66. </para>
  67. <programlisting language="php"><![CDATA[
  68. $bugs = new Bugs();
  69. $rowset = $bugs->fetchAll("bug_id = 1");
  70. $row = $rowset->current();
  71. ]]></programlisting>
  72. </example>
  73. <para>
  74. Wenn der Zeilensatz keine Zeilen enthält, gibt <methodname>current()</methodname> den
  75. <acronym>PHP</acronym> Wert <constant>NULL</constant> zurück.
  76. </para>
  77. <example id="zend.db.table.rowset.rows.iterate.example">
  78. <title>Einen Zeilensatz durchlaufen</title>
  79. <para>
  80. Objekte, die von <classname>Zend_Db_Table_Rowset_Abstract</classname> abstammen,
  81. implementieren das <classname>SeekableIterator</classname> Interface, was bedeutet,
  82. dass es mit <methodname>foreach()</methodname> durchlaufen werden kann. Jeder Wert,
  83. der auf diesem Weg zurückgegeben wird, ist ein
  84. <classname>Zend_Db_Table_Row_Abstract</classname>-Objekt, das zu einem Eintrag in
  85. der Tabelle gehört.
  86. </para>
  87. <programlisting language="php"><![CDATA[
  88. $bugs = new Bugs();
  89. // Alle Zeilen aus der Tabelle lesen
  90. $rowset = $bugs->fetchAll();
  91. foreach ($rowset as $row) {
  92. // Ausgabe: 'Zend_Db_Table_Row' oder ähnlich,
  93. // je nach benutzter Zeilenklasse
  94. echo get_class($row) . "\n";
  95. // Spalte einer Zeile auslesen
  96. $status = $row->bug_status;
  97. // eine Spalte der aktuellen Zeile modifizieren
  98. $row->assigned_to = 'mmouse';
  99. // Änderung in der Datenbank speichern
  100. $row->save();
  101. }
  102. ]]></programlisting>
  103. </example>
  104. <example id="zend.db.table.rowset.rows.seek.example">
  105. <title>Eine bekannte Position in einem Rowset suchen</title>
  106. <para>
  107. <classname>SeekableIterator</classname> erlaubt es eine Position zu suchen auf die
  108. der Iterator springen soll. Hierfür kann einfach die <methodname>seek()</methodname>
  109. Methode verwendet werden. Es kann ein Integer übergeben werden die der Nummer der
  110. Zeile repräsentiert auf die das Rowset als nächstes zeigen soll, wobei man nicht
  111. vergessen sollte das der Index mit 0 beginnt. Wenn der Index falsch ist, z.b. nicht
  112. existiert, wird eine Ausnahme geworfen. Man sollte <methodname>count()</methodname>
  113. verwenden um die Anzahl an Ergebnissen zu prüfen bevor eine Position gesucht wird.
  114. </para>
  115. <programlisting language="php"><![CDATA[
  116. $bugs = new Bugs();
  117. // Alle Einträge von der Tabelle holen
  118. $rowset = $bugs->fetchAll();
  119. // Den Iterator zum 9ten Element bringen (null ist das erste Element) :
  120. $rowset->seek(8);
  121. // es empfangen
  122. $row9 = $rowset->current();
  123. // und es verwenden
  124. $row9->assigned_to = 'mmouse';
  125. $row9->save();
  126. ]]></programlisting>
  127. </example>
  128. <para>
  129. <methodname>getRow()</methodname> erlaubt es eine spezielle Zeile im Rowset zu erhalten
  130. wenn dessen Position bekannt ist; trotzdem sollte nicht vergessen werden dass die
  131. Position mit dem Index Null beginnt. Der erste Parameter für
  132. <methodname>getRow()</methodname> ist ein Integer für die gewünschte Position. Der
  133. zweite optionale Parameter ist ein Boolean; Es teilt dem Rowset Iterator mit ob er zur
  134. gleichen Zeit diese Position suchen muss, oder nicht (standard ist
  135. <constant>FALSE</constant>). Diese Methode gibt standardmäßig ein
  136. <classname>Zend_Db_Table_Row</classname> Objekt zurück. Wenn die angefragte Position
  137. nicht existiert wird eine Ausnahme geworfen. Hier ist ein Beispiel:
  138. </para>
  139. <programlisting language="php"><![CDATA[
  140. $bugs = new Bugs();
  141. // Alle Einträge von der Tabelle holen
  142. $rowset = $bugs->fetchAll();
  143. // Sofort das 9te Element holen:
  144. $row9->getRow(8);
  145. // und es verwenden:
  146. $row9->assigned_to = 'mmouse';
  147. $row9->save();
  148. ]]></programlisting>
  149. <para>
  150. Sobald der Zugriff auf ein Zeilenobjekt besteht, kann dieses mit den Methoden
  151. manipuliert werden, die in <link linkend="zend.db.table.row">Zend_Db_Table_Row</link>
  152. beschrieben werden.
  153. </para>
  154. </sect2>
  155. <sect2 id="zend.db.table.rowset.to-array">
  156. <title>Einen Zeilensatz als Array lesen</title>
  157. <para>
  158. Auf die gesamten Daten in einem Zeilensatz kann mithilfe der Methode
  159. <methodname>toArray()</methodname> des Zeilensatz-Objekts auch als Array zugegriffen
  160. werden. Diese Methode gibt ein Array mit einem Eintrag je Zeile zurück. Jeder dieser
  161. Einträge ist ein assoziatives Array mit Spaltennamen als Schlüsseln und deren Daten als
  162. Werten.
  163. </para>
  164. <example id="zend.db.table.rowset.to-array.example">
  165. <title>Benutzung von toArray()</title>
  166. <programlisting language="php"><![CDATA[
  167. $bugs = new Bugs();
  168. $rowset = $bugs->fetchAll();
  169. $rowsetArray = $rowset->toArray();
  170. $rowCount = 1;
  171. foreach ($rowsetArray as $rowArray) {
  172. echo "Zeile #$rowCount:\n";
  173. foreach ($rowArray as $column => $value) {
  174. echo "\t$column => $value\n";
  175. }
  176. ++$rowCount;
  177. echo "\n";
  178. }
  179. ]]></programlisting>
  180. </example>
  181. <para>
  182. Das Array, das von <methodname>toArray()</methodname>zurückgegeben wird, ist nicht
  183. update-fähig. Die Werte des Arrays können wie bei jedem Array modifiziert werden, aber
  184. Änderungen an diesem Array werden nicht direkt in der Datenbank gespeichert.
  185. </para>
  186. </sect2>
  187. <sect2 id="zend.db.table.rowset.serialize">
  188. <title>Einen Zeilensatz serialisieren / deserialisieren</title>
  189. <para>
  190. Objekte vom Typ <classname>Zend_Db_Table_Rowset_Abstract</classname> sind serialisierbar
  191. auf eine ähnliche Art, wie auch einzelne Zeilen-Objekte serialisierbar und
  192. deserialisierbar sind.
  193. </para>
  194. <example id="zend.db.table.rowset.serialize.example.serialize">
  195. <title>Einen Zeilensatz serialisieren</title>
  196. <para>
  197. <acronym>PHP</acronym>s <methodname>serialize()</methodname>-Funktion wird genutzt,
  198. um einen Byte-Stream zu erzeugen. Dieser repräsentiert das Zeilensatz-Objekt.
  199. </para>
  200. <programlisting language="php"><![CDATA[
  201. $bugs = new Bugs();
  202. $rowset = $bugs->fetchAll();
  203. // Objekt serialisieren
  204. $serializedRowset = serialize($rowset);
  205. // Jetzt kann $serializedRowset bspw.
  206. // in einer Datei gespeichert werden
  207. ]]></programlisting>
  208. </example>
  209. <example id="zend.db.table.rowset.serialize.example.unserialize">
  210. <title>Einen Zeilensatz deserialisieren</title>
  211. <para>
  212. <acronym>PHP</acronym>s <methodname>unserialize()</methodname> stellt aus einer
  213. Zeichenkette mit einem Byte-Stream ein Objekt wieder her. Die Funktion gibt das
  214. originale Objekt zurück.
  215. </para>
  216. <para>
  217. Bitte beachten: Das zurückgegebene Zeilensatz-Objekt ist
  218. <emphasis>nicht mit der Datenbank verbunden</emphasis>. Das Zeilensatz-Objekt kann
  219. durchlaufen werden und die Zeilenobjekte können gelesen werden, aber es können keine
  220. Zeilenwerte verändert oder andere Operationen ausgeführt werden, die eine
  221. Datenbankverbindung benötigen (beispielsweise Abfragen auf verwandte Tabellen).
  222. </para>
  223. <programlisting language="php"><![CDATA[
  224. $rowsetDisconnected = unserialize($serializedRowset);
  225. // Jetzt können Objekt-Methoden und -Eigenschaften genutzt werden,
  226. // aber nur lesend.
  227. $row = $rowsetDisconnected->current();
  228. echo $row->bug_description;
  229. ]]></programlisting>
  230. </example>
  231. <note>
  232. <title>Warum werden Zeilensatz-Objekte unverbunden deserialisiert?</title>
  233. <para>
  234. Ein serialisiertes Objekt ist eine Zeichenkette, die lesbar für jeden ist, dem sie
  235. vorliegt. Es könnte ein Sicherheitsrisiko sein, Parameter wie Datenbank-Loginname
  236. und -Passwort in simplem, unverschlüsseltem Text abzulegen. Es ist nicht
  237. wünschenswert, solche Daten in einer Textdatei abzulegen, die nicht geschützt ist,
  238. oder sie in einer E-Mail oder einem anderen Medium zu versenden, das leicht von
  239. potentiellen Angreifern lesbar ist. Der Leser des serialisierten Objekts sollte es
  240. nicht benutzen können, um Zugriff zur Datenbank zu erhalten, ohne richtige
  241. Logindaten zu kennen.
  242. </para>
  243. </note>
  244. <para>
  245. Ein nicht verbundenes Zeilensatz-Objekt kann mithilfe der Methode
  246. <methodname>setTable()</methodname> reaktiviert werden. Das Argument dieser Methode ist
  247. ein valides <classname>Zend_Db_Table_Abstract</classname>-Objekt,
  248. das vom Benutzer erstellt wird. Für das Erstellen eines Tabellenobjekts wird eine
  249. aktive Datenbankverbindung benötigt, also wird, indem die Tabelle wieder mit dem
  250. Zeilenobjekt verknüpft wird, auch der Datenbankzugriff wiederhergestellt. Ab diesem
  251. Zeitpunkt können Werte in den enthaltenen Zeilenobjekten wieder verändert und in der
  252. Datenbank gespeichert werden.
  253. </para>
  254. <example id="zend.db.table.rowset.serialize.example.set-table">
  255. <title>Einen Zeilensatz als Live-Daten reaktivieren</title>
  256. <programlisting language="php"><![CDATA[
  257. $rowset = unserialize($serializedRowset);
  258. $bugs = new Bugs();
  259. // Den Zeilensatz wieder mit einer Tabelle
  260. // und damit mit einer aktiven Datenbankverbindung verknüpfen
  261. $rowset->setTable($bugs);
  262. $row = $rowset->current();
  263. // Jetzt können wieder Werte geändert und danach gespeichert werden
  264. $row->bug_status = 'FIXED';
  265. $row->save();
  266. ]]></programlisting>
  267. </example>
  268. <para>
  269. Wenn ein Zeilensatz mit <methodname>setTable()</methodname> reaktiviert wird,
  270. reaktiviert das auch alle enthaltenen Zeilen-Objekte.
  271. </para>
  272. </sect2>
  273. <sect2 id="zend.db.table.rowset.extending">
  274. <title>Die Zeilensatz-Klasse erweitern</title>
  275. <para>
  276. Es können auch alternative Klassen für Zeilensätze benutzt werden, wenn diese
  277. <classname>Zend_Db_Table_Rowset_Abstract</classname> erweitern. Der Name der eigenen
  278. Zeilensatz-Klasse wird entweder in der geschützten Tabellenklassen-Eigenschaft
  279. <varname>$_rowsetClass</varname> oder als Teil des Array-Arguments des Konstruktors
  280. eines Tabellenobjekts übergeben.
  281. </para>
  282. <example id="zend.db.table.rowset.extending.example">
  283. <title>Eine eigene Zeilensatz-Klasse angeben</title>
  284. <programlisting language="php"><![CDATA[
  285. class MyRowset extends Zend_Db_Table_Rowset_Abstract
  286. {
  287. // ...Anpassungen
  288. }
  289. // Eine eigene Zeilensatz-Klasse angeben, die standardmäßig
  290. // in allen Instanzen der Tabellenklasse benutzt wird.
  291. class Products extends Zend_Db_Table_Abstract
  292. {
  293. protected $_name = 'products';
  294. protected $_rowsetClass = 'MyRowset';
  295. }
  296. // Oder eine eigene Zeilensatz-Klasse angeben, die in einer
  297. // Instanz einer Tabellenklasse benutzt wird
  298. $bugs = new Bugs(array('rowsetClass' => 'MyRowset'));
  299. ]]></programlisting>
  300. </example>
  301. <para>
  302. Typischerweise reicht die Standardklasse <classname>Zend_Db_Rowset</classname> für die
  303. meisten Benutzungsfälle aus. Trotzdem könnte es nützlich sein, neue Logik in einen
  304. Zeilensatz einzubauen, die für eine bestimmte Tabelle nötig ist. Beispielsweise könnte
  305. eine neue Methode einen Durchschnitt aller Zeilen im Zeilensatz errechnen.
  306. </para>
  307. <example id="zend.db.table.rowset.extending.example-aggregate">
  308. <title>Eine Zeilensatz-Klasse mit einer neuen Methode</title>
  309. <programlisting language="php"><![CDATA[
  310. class MyBugsRowset extends Zend_Db_Table_Rowset_Abstract
  311. {
  312. /**
  313. * Suche nach der Zeile im Zeilensatz, deren
  314. * 'updated_at'-Spalte den größten Wert hat.
  315. */
  316. public function getLatestUpdatedRow()
  317. {
  318. $max_updated_at = 0;
  319. $latestRow = null;
  320. foreach ($this as $row) {
  321. if ($row->updated_at > $max_updated_at) {
  322. $latestRow = $row;
  323. }
  324. }
  325. return $latestRow;
  326. }
  327. }
  328. class Bugs extends Zend_Db_Table_Abstract
  329. {
  330. protected $_name = 'bugs';
  331. protected $_rowsetClass = 'MyBugsRowset';
  332. }
  333. ]]></programlisting>
  334. </example>
  335. </sect2>
  336. </sect1>