Zend_Db_Statement.xml 16 KB

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