Zend_Db_Statement.xml 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15207 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.db.statement">
  5. <title>Zend_Db_Statement</title>
  6. <para>
  7. Zusätzlich zu den herkömmlichen Methoden wie <code>fetchAll()</code> und <code>insert()</code>,
  8. beschrieben in <xref linkend="zend.db.adapter" />, kann auch ein Statement-Objekt verwendet werden,
  9. um zusätzliche Möglichkeiten beim Ausführen von Abfragen und holen von Ergebnissätzen zu erhalten.
  10. Dieser Abschnitt beschreibt wie eine Instanz eines Statement-Objekts erzeugt wird, und wie dessen
  11. Methoden verwendet werden.
  12. </para>
  13. <para>
  14. <classname>Zend_Db_Statement</classname> basiert auf dem PDOStatement Objekt aus der <ulink url="http://www.php.net/pdo">PHP Data Objects</ulink>
  15. Erweiterung.
  16. </para>
  17. <sect2 id="zend.db.statement.creating">
  18. <title>Erzeugung von Statement Objekten</title>
  19. <para>
  20. Normalerweise wird ein Statement Objekt von der <code>query()</code> Methode der Datenbank
  21. Adapterklasse zurück gegeben. Diese Methode ist der grundsätzliche Weg um ein beliebiges SQL Statement
  22. vor zu bereiten. Das erste Argument ist ein String, der das SQL Statement enthält. Das optionale zweite
  23. Argument ist ein Array von Werten, verknüpft mit Parameterplatzhaltern im SQL String.
  24. </para>
  25. <example id="zend.db.statement.creating.example1">
  26. <title>Erzeugung eines SQL Statement Objekts mit query()</title>
  27. <programlisting role="php"><![CDATA[
  28. $stmt = $db->query(
  29. 'SELECT * FROM bugs WHERE reported_by = ? AND bug_status = ?',
  30. array('goofy', 'FIXED')
  31. );
  32. ]]></programlisting>
  33. </example>
  34. <para>
  35. Das Statement Objekt entspricht einem SQL Statement welches vorbereitet und einmalig mit angegebenen
  36. verknüpften Werten ausgeführt wurde. War das Statement eine SELECT Abfrage, oder irgendein Statement
  37. welches ein Ergebnissatz zurück gibt, so ist es nun bereit um Ergebnisse zu holen.
  38. </para>
  39. <para>
  40. Ein Statement kann ebenfalls mit dem Konstruktor erzeugt werden, auch wenn dies eine weniger typische
  41. Nutzung ist. Es existiert jedoch keine factory Methode um das Objekt zu erzeugen, weßhalb die
  42. entsprechende Statementklasse geladen, und ihr Konstruktor aufgerufen werden muss. Als erstes Argument
  43. muss das Adapterobjekt übergeben werden und als zweites Argument ein String welcher das SQL Statement
  44. enthält. Das Statement ist dadurch vorbereitet, jedoch nicht Ausgeführt.
  45. </para>
  46. <example id="zend.db.statement.creating.example2">
  47. <title>Nutzung des SQL Statement Konstruktors</title>
  48. <programlisting role="php"><![CDATA[
  49. $sql = 'SELECT * FROM bugs WHERE reported_by = ? AND bug_status = ?';
  50. $stmt = new Zend_Db_Statement_Mysqli($db, $sql);
  51. ]]></programlisting>
  52. </example>
  53. </sect2>
  54. <sect2 id="zend.db.statement.executing">
  55. <title>Ausführen eines Statements</title>
  56. <para>
  57. Ein Statement Objekt muss ausgeführt werden wenn es über den Konstruktor erzeugt wurde, oder kann, wenn
  58. es mehrere Male hintereinander ausgeführt werden soll. Dazu wird die <code>execute()</code> Methode des
  59. Statement Objekts verwendet. Das einzige Argument ist ein Array von Werten, welche mit
  60. Parameterplatzhaltern im Statement verknüpft werden.
  61. </para>
  62. <para>
  63. Wenn <emphasis>positionierte Parameter</emphasis>, oder solche, die mit dem Fragezeichen (<code>?</code>)
  64. verwendet werden, muss ein einfaches Array übergeben werden.
  65. </para>
  66. <example id="zend.db.statement.executing.example1">
  67. <title>Ausführen eines Statements mit positionierten Parametern</title>
  68. <programlisting role="php"><![CDATA[
  69. $sql = 'SELECT * FROM bugs WHERE reported_by = ? AND bug_status = ?';
  70. $stmt = new Zend_Db_Statement_Mysqli($db, $sql);
  71. $stmt->execute(array('goofy', 'FIXED'));
  72. ]]></programlisting>
  73. </example>
  74. <para>
  75. Wenn <emphasis>benannte Parameter</emphasis>, oder solche die mit einem String und voranstehenden
  76. Doppelpunkt (<code>:</code>) bezeichnet werden, verwendet werden, muss ein assoziatives Array übergeben
  77. werden. Die Schlüssel dieses Arrays müssen den Parameternamen entsprechen.
  78. </para>
  79. <example id="zend.db.statement.executing.example2">
  80. <title>Ausführen eines Statements mit benannten Parametern</title>
  81. <programlisting role="php"><![CDATA[
  82. $sql = 'SELECT * FROM bugs WHERE ' .
  83. 'reported_by = :reporter AND bug_status = :status';
  84. $stmt = new Zend_Db_Statement_Mysqli($db, $sql);
  85. $stmt->execute(array(':reporter' => 'goofy', ':status' => 'FIXED'));
  86. ]]></programlisting>
  87. </example>
  88. <para>
  89. PDO Statements unterstützen sowohl postionierte als auch benannte Parameter, jedoch nicht beide Typen
  90. in einem einzelnen SQL Statement. Einige der <classname>Zend_Db_Statement</classname> Klassen für nicht-PDO Erweiterungen
  91. könnten nur einen Typ von Parametern unterstützen.
  92. </para>
  93. </sect2>
  94. <sect2 id="zend.db.statement.fetching">
  95. <title>Holen von Ergebnissen eines SELECT Statements</title>
  96. <para>
  97. Es können Methoden des Statement Objekts aufgefufen werden um Ergebnissätze zu erzeugen. SELECT, SHOW,
  98. DESCRIBE und EXPLAIN sind Beispiele von von Statements die Ergebnissätze erzeugen. INSERT, UPDATE und
  99. DELETE sind Beispiele von Statements die keine Ergebnissätze erzeugen. Letztere Statements können zwar
  100. mit <classname>Zend_Db_Statement</classname> ausgeführt werden, aber Methoden die Zeilen oder Ergebnisse liefern können bei
  101. diesen nicht verwendet werden.
  102. </para>
  103. <sect3 id="zend.db.statement.fetching.fetch">
  104. <title>Holen einer einzelnen Zeile eines Ergebnissatzes</title>
  105. <para>
  106. Um eine einzelne Zeile eines Ergebnissatzes aubzurufen kann die <code>fetch()</code> Methode des
  107. Statement Objekts verwendet werden. Alle drei Argumente dieser Methode sind optional:
  108. </para>
  109. <itemizedlist>
  110. <listitem>
  111. <para>
  112. <emphasis role="strong">Fetch Style</emphasis> ist das erste Argument. Es steuert die
  113. Struktur in welcher die Zeile zurück gegeben wird. Unter <xref linkend="zend.db.adapter.select.fetch-mode" />
  114. befindet sich eine Beschreibung der gültigen Werte und der entsprechenden Datenformaten.
  115. </para>
  116. </listitem>
  117. <listitem>
  118. <para>
  119. <emphasis role="strong">Cursor Ausrichtung</emphasis> ist das zweite Argument. Standard ist
  120. Zend_Db::FETCH_ORI_NEXT, was einfach bedeutet das für jeden Aufruf von <code>fetch()</code>
  121. die nächste Zeile des Ergebnissatzes, in der Riehenfolge des RDBMS, zurück gegeben wird.
  122. </para>
  123. </listitem>
  124. <listitem>
  125. <para>
  126. <emphasis role="strong">Offset</emphasis> ist das dritte Argument.
  127. Wenn die Cursor Ausrichtung Zend_Db::FETCH_ORI_ABS ist, dann ist die Offset-Nummer die
  128. ordinale Nummer der Zeile die zurück gegeben wird.
  129. Wenn die Cursor Ausrichtung Zend_Db::FETCH_ORI_REL, dann ist die Offset-Nummer relativ zu
  130. der Cursorposition bevor <code>fetch()</code> aufgerufen wurde.
  131. </para>
  132. </listitem>
  133. </itemizedlist>
  134. <para>
  135. <code>fetch()</code> gibt <code>false</code> zurück wenn alle Zeilen des Ergbnissatzes geholt wurden.
  136. </para>
  137. <example id="zend.db.statement.fetching.fetch.example">
  138. <title>Nutzung fetch() in einer Schleife</title>
  139. <programlisting role="php"><![CDATA[
  140. $stmt = $db->query('SELECT * FROM bugs');
  141. while ($row = $stmt->fetch()) {
  142. echo $row['bug_description'];
  143. }
  144. ]]></programlisting>
  145. </example>
  146. <para>
  147. Weitere Informationen unter <ulink url="http://www.php.net/PDOStatement-fetch">PDOStatement::fetch()</ulink>.
  148. </para>
  149. </sect3>
  150. <sect3 id="zend.db.statement.fetching.fetchall">
  151. <title>Holen eines gesamten Ergebnissatzes</title>
  152. <para>
  153. Um alle Zeilen eines Ergebnissatzes in einem Schritt abzurufen wird die <code>fetchAll()</code> Methode
  154. verwendet. Dies ist gleichbedeutend mit dem Aufruf der <code>fetch()</code> Methode in einer Schleife
  155. und dem Speichern der Rückgabewerte in einem Array.
  156. Die <code>fetchAll()</code> Methode akzeptiert zwei Argumente. Das Erste ist der Fetch Style, wie oben
  157. beschrieben, und das Zweite gibt die Nummer der zurück zu gebenden Spalte an, wenn der Fetch Style
  158. Zend_Db::FETCH_COLUMN ist.
  159. </para>
  160. <example id="zend.db.statement.fetching.fetchall.example">
  161. <title>Nutzung von fetchAll()</title>
  162. <programlisting role="php"><![CDATA[
  163. $stmt = $db->query('SELECT * FROM bugs');
  164. $rows = $stmt->fetchAll();
  165. echo $rows[0]['bug_description'];
  166. ]]></programlisting>
  167. </example>
  168. <para>
  169. Weitere Informationen unter <ulink url="http://www.php.net/PDOStatement-fetchAll">PDOStatement::fetchAll()</ulink>.
  170. </para>
  171. </sect3>
  172. <sect3 id="zend.db.statement.fetching.fetch-mode">
  173. <title>Ändern des Fetch Modus</title>
  174. <para>
  175. Standardmäßig gibt das Statement Objekt Zeilen des Ergebnissatzes als assoziatives Array, mapping
  176. column names to column values, zurück. Ein anderes Format für die Datenrückgabe der Statementklasse
  177. kann genau wie bei der Adapterklasse angegeben werden. Die <code>setFetchMode()</code> Methode des
  178. Statement Objekts wird verwendet um den Fetch-Modus anzugeben. Dazu werden die Zend_Db Klassen
  179. Konstanten FETCH_ASSOC, FETCH_NUM, FETCH_BOTH, FETCH_COLUMN und FETCH_OBJ verwendet.
  180. Weiter Informationenüber diese Modi gibt es unter <xref linkend="zend.db.adapter.select.fetch-mode" />.
  181. Nachfolgende Aufrufe der Statement Methoden <code>fetch()</code> und <code>fetchAll()</code> benutzen
  182. den neu gesetzten Fetch-Modus.
  183. </para>
  184. <example id="zend.db.statement.fetching.fetch-mode.example">
  185. <title>Ändern des Fetch-Modus</title>
  186. <programlisting role="php"><![CDATA[
  187. $stmt = $db->query('SELECT * FROM bugs');
  188. $stmt->setFetchMode(Zend_Db::FETCH_NUM);
  189. $rows = $stmt->fetchAll();
  190. echo $rows[0][0];
  191. ]]></programlisting>
  192. </example>
  193. <para>
  194. Weitere Informationen unter <ulink url="http://www.php.net/PDOStatement-setFetchMode">PDOStatement::setFetchMode()</ulink>.
  195. </para>
  196. </sect3>
  197. <sect3 id="zend.db.statement.fetching.fetchcolumn">
  198. <title>Holen einer einzelnen Spalte eines Ergebnissatzes</title>
  199. <para>
  200. <code>fetchColumn()</code> wird verwendet mm eine einzelne Spalte eines Ergebnissatzes zurück zu
  201. geben. Das optionale Argument ist der Integer Index der Spalte die zurück gegeben werden soll. Der
  202. Standardwert ist 0. Diese Methode gibt einen scalaren Wert zurück, oder <code>false</code> wenn alle
  203. Zeilen des Ergebnissatzes bereits geholt wurden.
  204. </para>
  205. <para>
  206. Zu beachten ist, dass diese Methode anders als die <code>fetchCol()</code> Methode der Adapterklasse
  207. arbeitet. Die <code>fetchColumn()</code> Methode der Statementklasse gibt einen einzelnen Wert einer
  208. Zeile zurück.
  209. Die <code>fetchCol()</code> Methode der Adapterklasse hingegen gibt ein Array von Werten der ersten Spalte
  210. aller Zeilen eines Ergebnissatzes zurück.
  211. </para>
  212. <example id="zend.db.statement.fetching.fetchcolumn.example">
  213. <title>Nutzung von fetchColumn()</title>
  214. <programlisting role="php"><![CDATA[
  215. $stmt = $db->query('SELECT bug_id, bug_description, bug_status FROM bugs');
  216. $bug_status = $stmt->fetchColumn(2);
  217. ]]></programlisting>
  218. </example>
  219. <para>
  220. Weitere Informationen unter <ulink url="http://www.php.net/PDOStatement-fetchColumn">PDOStatement::fetchColumn()</ulink>.
  221. </para>
  222. </sect3>
  223. <sect3 id="zend.db.statement.fetching.fetchobject">
  224. <title>Holen einer Zeile als Objekt</title>
  225. <para>
  226. Um eine Zeile eines Ergebnissatzes zu holen, die wie ein Objekt strukturiert ist, wird die <code>fetchObject()</code>
  227. Methode verwendet.
  228. Diese Methode nimmt zwei optionale Argumente entgegen. Das erste Argument ist ein String der den
  229. Klassenname des zurück zu gebenden Objekts enthält, standard ist 'stdClass'. Das zweite Argument
  230. ist ein Array von Werten, die an den Konstruktor des Objekts übergeben werden.
  231. </para>
  232. <example id="zend.db.statement.fetching.fetchobject.example">
  233. <title>Nutzung von fetchObject()</title>
  234. <programlisting role="php"><![CDATA[
  235. $stmt = $db->query('SELECT bug_id, bug_description, bug_status FROM bugs');
  236. $obj = $stmt->fetchObject();
  237. echo $obj->bug_description;
  238. ]]></programlisting>
  239. </example>
  240. <para>
  241. Weitere Informationen unter <ulink url="http://www.php.net/PDOStatement-fetchObject">PDOStatement::fetchObject()</ulink>.
  242. </para>
  243. </sect3>
  244. </sect2>
  245. <!--
  246. @todo: binding parameters is not working yet.
  247. <sect2 id="zend.db.statement.binding-param">
  248. <title>Binding PHP Variables to Parameters</title>
  249. <para>
  250. </para>
  251. <example id="zend.db.statement.binding-param.example">
  252. <title>Binding parameters from PHP variables</title>
  253. <programlisting role="php"><![CDATA[
  254. ]]></programlisting>
  255. </example>
  256. <para>
  257. See also <ulink url="http://www.php.net/PDOStatement-bindParam">PDOStatement::bindParam()</ulink>.
  258. </para>
  259. </sect2>
  260. -->
  261. <!--
  262. @todo: binding columns is not working yet.
  263. <sect2 id="zend.db.statement.binding-column">
  264. <title>Binding PHP Variables to Query Results</title>
  265. <para>
  266. </para>
  267. <example id="zend.db.statement.binding-column.example">
  268. <title>Binding results to PHP variables</title>
  269. <programlisting role="php"><![CDATA[
  270. ]]></programlisting>
  271. </example>
  272. <para>
  273. See also <ulink url="http://www.php.net/PDOStatement-bindColumn">PDOStatement::bindColumn()</ulink>.
  274. </para>
  275. </sect2>
  276. -->
  277. </sect1>