php-doc-en/reference/pdo/functions/PDOStatement-fetchAll.xml

<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.10 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
  <refentry id="function.PDOStatement-fetchAll">
   <refnamediv>
    <refname>PDOStatement::fetchAll</refname>
    <refpurpose>
     Returns an array containing all of the result set rows
    </refpurpose>
   </refnamediv>
   <refsect1 role="description">
    &reftitle.description;
    <methodsynopsis>
     <type>array</type><methodname>PDOStatement::fetchAll</methodname>
     <methodparam choice="opt"><type>int</type><parameter>fetch_style</parameter></methodparam>
     <methodparam choice="opt"><type>int</type><parameter>column_index</parameter></methodparam>
    </methodsynopsis>

   </refsect1>

   <refsect1 role="parameters">
    &reftitle.parameters;
    <para>
     <variablelist>
      <varlistentry>
       <term><parameter>fetch_style</parameter></term>
       <listitem>
        <para>
         Controls the contents of the returned array as documented in
         <function>PDOStatement::fetch</function>. Defaults to
         <literal>PDO::FETCH_BOTH</literal>.
        </para>
        <para>
         To return an array consisting of all values of a single column from
         the result set, specify <literal>PDO::FETCH_COLUMN</literal>. You
         can specify which column you want with the
         <parameter>column-index</parameter> parameter.
        </para>
        <para>
         To fetch only the unique values of a single column from the result set,
         bitwise-OR <literal>PDO::FETCH_COLUMN</literal> with
         <literal>PDO::FETCH_UNIQUE</literal>.
        </para>
        <para>
         To return an associative array grouped by the values of a specified
         column, bitwise-OR <literal>PDO::FETCH_COLUMN</literal> with
         <literal>PDO::FETCH_GROUP</literal>.
        </para>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><parameter>column_index</parameter></term>
       <listitem>
        <para>
         Returns the indicated 0-indexed column when the value of
         <parameter>fetch_style</parameter> is
         <literal>PDO::FETCH_COLUMN</literal>. Defaults to <literal>0</literal>.
        </para>
       </listitem>
      </varlistentry>
     </variablelist>
    </para>
   </refsect1>

   <refsect1 role="returnvalues">
    &reftitle.returnvalues;
    <para>
     <function>PDOStatement::fetchAll</function> returns an array containing
     all of the remaining rows in the result set. The array represents each
     row as either an array of column values or an object with properties
     corresponding to each column name.
    </para>
    <para>
     Using this method to fetch large result sets will result in a heavy
     demand on system and possibly network resources. Rather than retrieving
     all of the data and manipulating it in PHP, consider using the database
     server to manipulate the result sets. For example, use the WHERE and
     SORT BY clauses in SQL to restrict results before retrieving and
     processing them with PHP.
    </para>
   </refsect1>

   <refsect1 role="examples">
    &reftitle.examples;
    <para>
     <example><title>Fetch all remaining rows in a result set</title>
      <programlisting role="php">
<![CDATA[
<?php
$sth = $dbh->prepare("SELECT name, colour FROM fruit");
$sth->execute();

/* Fetch all of the remaining rows in the result set */
print("Fetch all of the remaining rows in the result set:\n");
$result = $sth->fetchAll();
print_r($result);
?>
]]>
      </programlisting>
      &example.outputs;
      <screen>
<![CDATA[
Fetch all of the remaining rows in the result set:
Array
(
    [0] => Array
        (
            [NAME] => pear
            [0] => pear
            [COLOUR] => green
            [1] => green
        )

    [1] => Array
        (
            [NAME] => watermelon
            [0] => watermelon
            [COLOUR] => pink
            [1] => pink
        )

)
]]>
      </screen>
     </example>
     <example><title>Fetching all values of a single column from a result set</title>
      <para>
       The following example demonstrates how to return all of the values of a
       single column from a result set, even though the SQL statement itself
       may return multiple columns per row.
      </para>
      <programlisting role="php">
<![CDATA[
<?php
$sth = $dbh->prepare("SELECT name, colour FROM fruit");
$sth->execute();

/* Fetch all of the values of the first column */
$result = $sth->fetchAll(PDO::FETCH_COLUMN, 0);
var_dump($result);
?>
]]>
      </programlisting>
      &example.outputs;
      <screen>
<![CDATA[
Array(3)
(
    [0] =>
    string(5) => apple
    [1] =>
    string(4) => pear
    [2] =>
    string(10) => watermelon
)
]]>
      </screen>
     </example>
     <example><title>Grouping all values by a single column</title>
      <para>
       The following example demonstrates how to return an associative array
       grouped by the values of the specified column in the result set. The
       array contains three keys: values <literal>apple</literal> and
       <literal>pear</literal> are returned as arrays that contain two
       different colours, while <literal>watermelon</literal> is
       returned as an array that contains only one colour.
      </para>
      <programlisting role="php">
<![CDATA[
<?php
$insert = $dbh->prepare("INSERT INTO fruit(name, colour) VALUES (?, ?)");
$insert->execute('apple', 'green');
$insert->execute('pear', 'yellow');

$sth = $dbh->prepare("SELECT name, colour FROM fruit");
$sth->execute();

/* Group values by the first column */
var_dump($sth->fetchAll(PDO::FETCH_COLUMN|PDO::FETCH_GROUP));
?>
]]>
      </programlisting>
      &example.outputs;
      <screen>
<![CDATA[
array(3) {
  ["apple"]=>
  array(2) {
    [0]=>
    string(5) "green"
    [1]=>
    string(3) "red"
  }
  ["pear"]=>
  array(2) {
    [0]=>
    string(5) "green"
    [1]=>
    string(6) "yellow"
  }
  ["watermelon"]=>
  array(1) {
    [0]=>
    string(5) "green"
  }
}

]]>
      </screen>
     </example>

    </para>
   </refsect1>

   <refsect1 role="seealso">
    &reftitle.seealso;
    <para>
     <simplelist>
      <member><function>PDO::query</function></member>
      <member><function>PDOStatement::fetch</function></member>
      <member><function>PDOStatement::fetchColumn</function></member>
      <member><function>PDOStatement::prepare</function></member>
      <member><function>PDOStatement::setFetchMode</function></member>
     </simplelist>
    </para>
   </refsect1>
  </refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->