Zend_Db_Statement.xml 16 KB

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