PDOStatement::fetchAll

PHP PDO 参考手册PHP PDO リファレンスマニュアル

PDOStatement::fetchAll — 結果セット内のすべての行を含む配列を返す (PHP 5 >= 5.1.0, PECL pdo >= 0.1.0)


説明

構文

array PDOStatement::fetchAll ([ int $fetch_style [, mixed $fetch_argument [, array $ctor_args = array() ]]] )

パラメータ

fetch_style

次の行を呼び出し元にどのように返すかを制御します。この値は PDO::FETCH_* 系の定数のいずれかである必要があります。デフォルトは PDO::ATTR_DEFAULT_FETCH_MODE の値(デフォルトは PDO::FETCH_BOTH)です。

結果セット内の単一の列のすべての値を含む配列を返すには、PDO::FETCH_COLUMN を指定する必要があります。column-index パラメータを指定して、必要な列を取得します。

結果セット内の単一の列の一意の値を取得するには、PDO::FETCH_COLUMN と PDO::FETCH_UNIQUE をビット単位の OR で指定する必要があります。

指定した列で値をグループ化した連想配列を返すには、PDO::FETCH_COLUMN と PDO::FETCH_GROUP をビット単位の OR で指定する必要があります。

fetch_argument
fetch_style パラメータの値に応じて、このパラメータは異なる意味を持ちます:

  • PDO::FETCH_COLUMN:0 から始まるインデックスで指定された列を返します。

  • PDO::FETCH_CLASS:指定したクラスのインスタンスを返し、各行の列をクラスの対応するプロパティ名にマッピングします。

  • PDO::FETCH_FUNC:各行の列をパラメータとして指定した関数に渡し、関数を呼び出した結果を返します。

ctor_args
fetch_style パラメータが PDO::FETCH_CLASS の場合、カスタムクラスのコンストラクタのパラメータです。


戻り値

PDOStatement::fetchAll() は、結果セット内の残りのすべての行を含む配列を返します。この配列の各行は、列の値の配列か、各列名に対応するプロパティを持つオブジェクトのいずれかです。

このメソッドを使用して大きな結果セットを取得すると、システムの負荷が増大し、大量のネットワークリソースを消費する可能性があります。すべてのデータを取得してからPHPで操作するよりも、データベースサービスを使用して結果セットを処理することを検討してください。例えば、データを取得してPHPで処理する前に、SQL で WHERE や ORDER BY 句を使用して結果を制限します。


例

結果セット内の残りのすべての行を取得する

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

/* 获取结果集中所有剩余的行 */
print("Fetch all of the remaining rows in the result set:\n");
$result = $sth->fetchAll();
print_r($result);
?>

上記の例の出力は次のとおりです:

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
        )

)

結果セット内の単一の列のすべての値を取得する

次の例は、SQL 文自体は各行に複数の列を返す可能性がありますが、結果セットから単一の列のすべての値を返す方法を示しています。

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

/* 获取第一列所有值 */
$result = $sth->fetchAll(PDO::FETCH_COLUMN, 0);
var_dump($result);
?>

上記の例の出力は次のとおりです:

Array(3)
(
    [0] =>
    string(5) => apple
    [1] =>
    string(4) => pear
    [2] =>
    string(10) => watermelon
)

単一の列に基づいてすべての値をグループ化する

次の例は、結果セット内の指定した列の値に基づいてグループ化された連想配列を返す方法を示しています。この配列には3つのキーが含まれます。返された apple と pear の配列には2つの異なる色が含まれ、返された watermelon の配列には1つの色のみが含まれます。

<?php
$insert = $dbh->prepare("INSERT INTO fruit(name, colour) VALUES (?, ?)");
$insert->execute(array('apple', 'green'));
$insert->execute(array('pear', 'yellow'));

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

/* 根据第一列分组  */
var_dump($sth->fetchAll(PDO::FETCH_COLUMN|PDO::FETCH_GROUP));
?>

上記の例の出力は次のとおりです:

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"
  }
}

各行の結果に対してクラスをインスタンス化する

次の例は、PDO::FETCH_CLASS 取得スタイルの動作を示しています。

<?php
class fruit {
    public $name;
    public $colour;
}

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

$result = $sth->fetchAll(PDO::FETCH_CLASS, "fruit");
var_dump($result);
?>

上記の例の出力は次のとおりです:

array(3) {
  [0]=>
  object(fruit)#1 (2) {
    ["name"]=>
    string(5) "apple"
    ["colour"]=>
    string(5) "green"
  }
  [1]=>
  object(fruit)#2 (2) {
    ["name"]=>
    string(4) "pear"
    ["colour"]=>
    string(6) "yellow"
  }
  [2]=>
  object(fruit)#3 (2) {
    ["name"]=>
    string(10) "watermelon"
    ["colour"]=>
    string(4) "pink"
  }
}

各行に対して関数を1回呼び出す

次の例は、PDO::FETCH_FUNC 取得スタイルの動作を示しています。

<?php
function fruit($name, $colour) {
    return "{$name}: {$colour}";
}

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

$result = $sth->fetchAll(PDO::FETCH_FUNC, "fruit");
var_dump($result);
?>

上記の例の出力は次のとおりです:

array(3) {
  [0]=>
  string(12) "apple: green"
  [1]=>
  string(12) "pear: yellow"
  [2]=>
  string(16) "watermelon: pink"
}

PHP PDO 参考手册PHP PDO リファレンスマニュアル

その他の拡張機能