【PHP8.x】PDOStatement::fetchAll()メソッドの使い方

Copy
1<?php
2
3/**
4 * PDOStatement::fetchAll メソッドの基本的な使い方を示すサンプルコードです。
5 *
6 * この関数は、インメモリのSQLiteデータベースを使用し、
7 * データの挿入、SELECTクエリの実行、そしてfetchAllによる結果の取得を行います。
8 * システムエンジニアを目指す初心者の方にも理解しやすいように、
9 * 簡潔なコードと必要最低限のコメントで構成されています。
10 */
11function demonstratePdoFetchAll(): void
12{
13    // データベース接続情報 (インメモリSQLiteを使用)
14    // 通常はファイルパスやホスト名、データベース名、ユーザー名、パスワードを指定します。
15    $dsn = 'sqlite::memory:';
16
17    try {
18        // PDOオブジェクトを作成し、データベースに接続します。
19        // エラーモードを例外(PDO::ERRMODE_EXCEPTION)に設定することで、
20        // データベース操作中のエラーが発生した場合にPDOExceptionがスローされます。
21        $pdo = new PDO($dsn);
22        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
23
24        echo "データベースに接続しました。\n\n";
25
26        // サンプルのテーブルを作成します。
27        $pdo->exec("
28            CREATE TABLE IF NOT EXISTS users (
29                id INTEGER PRIMARY KEY AUTOINCREMENT,
30                name TEXT NOT NULL,
31                email TEXT UNIQUE NOT NULL
32            );
33        ");
34        echo "テーブル 'users' を作成しました。\n\n";
35
36        // サンプルデータを挿入します。
37        $pdo->exec("INSERT INTO users (name, email) VALUES ('Alice', 'alice@example.com');");
38        $pdo->exec("INSERT INTO users (name, email) VALUES ('Bob', 'bob@example.com');");
39        $pdo->exec("INSERT INTO users (name, email) VALUES ('Charlie', 'charlie@example.com');");
40        echo "サンプルデータを挿入しました。\n\n";
41
42        // SELECT クエリを実行し、PDOStatement オブジェクトを取得します。
43        $stmt = $pdo->query("SELECT id, name, email FROM users");
44
45        // fetchAll() メソッドを使って、結果セットの全ての行を配列として取得します。
46        // 引数なしの場合 (PDO::FETCH_DEFAULT)、各行は数値添字と連想添字の両方を持つ配列になります。
47        // 例: [0 => '1', 'id' => '1', 1 => 'Alice', 'name' => 'Alice', ...]
48        $allUsersDefault = $stmt->fetchAll();
49
50        echo "fetchAll() (デフォルト) で取得した全てのユーザーデータ:\n";
51        print_r($allUsersDefault);
52
53        // よく使われるオプションとして、連想配列のみで取得したい場合は PDO::FETCH_ASSOC を指定します。
54        echo "\nfetchAll(PDO::FETCH_ASSOC) で取得した全てのユーザーデータ (連想配列のみ):\n";
55        // fetchAllは結果セットを使い切るため、再度クエリを実行する必要があります。
56        $stmt = $pdo->query("SELECT id, name, email FROM users");
57        $allUsersAssoc = $stmt->fetchAll(PDO::FETCH_ASSOC);
58        print_r($allUsersAssoc);
59
60    } catch (PDOException $e) {
61        // データベース接続や操作中にエラーが発生した場合、ここで捕捉します。
62        echo "データベースエラー: " . $e->getMessage() . "\n";
63    } catch (Exception $e) {
64        // その他の予期せぬエラーを捕捉します。
65        echo "一般エラー: " . $e->getMessage() . "\n";
66    } finally {
67        // データベース接続を閉じる (PHPではスクリプト終了時に自動的に閉じられることが多いですが、
68        // 明示的にnullを設定することで接続を確実に閉じることができます)
69        $pdo = null;
70        echo "\nデータベース接続を閉じました。\n";
71    }
72}
73
74// 関数を実行します。
75demonstratePdoFetchAll();
76
77?>

PHPのPDOStatement::fetchAllメソッドは、データベースへのクエリ結果から全ての行を一度に配列として取得する際に利用されます。このメソッドは、SELECT文などで得られた結果セットをプログラム上で扱いやすい形に一括で変換するために非常に役立ちます。

引数$modeでは、結果の取得形式を指定できます。引数を省略するか、デフォルト値のPDO::FETCH_DEFAULTを指定した場合、戻り値の配列は各行が数値添字と連想添字の両方を持つ形式で格納されます。例えば、カラム名が'name'であれば、その値は$row[0]と$row['name']の両方でアクセス可能です。一方、PDO::FETCH_ASSOCを指定すると、各行は連想配列のみの形式で取得され、カラム名をキーとしてデータにアクセスできます。戻り値は常に、取得された全ての行を含む多次元配列となります。

提供されたサンプルコードでは、インメモリのSQLiteデータベースを利用して、まずデータベース接続、usersテーブルの作成、およびサンプルデータの挿入を行っています。その後、SELECTクエリを実行して得られたPDOStatementオブジェクトに対しfetchAll()メソッドを呼び出し、挿入された全てのユーザー情報を配列として一括取得し、その内容を表示しています。特にPDO::FETCH_ASSOCを指定した場合としない場合の、データ取得形式の違いも具体的に示されており、データベース操作で発生しうるエラーはtry-catchブロックで適切に処理されています。このようにfetchAllは、複数のデータベースレコードを効率的に取得するための、PHPにおける重要な機能です。

Copy
1<?php
2
3/**
4 * PDOStatement::fetchAll メソッドを使用して、データベースからすべての行を連想配列として取得するサンプル。
5 *
6 * この関数は、PHPのPDO拡張機能を使ってMySQLデータベースに接続し、
7 * 架空の 'users' テーブルからデータをフェッチします。
8 * '連想配列' として結果を取得するためには PDO::FETCH_ASSOC モードを使用します。
9 *
10 * @return array 取得したユーザーデータの配列。データが見つからない場合やエラー発生時は空の配列。
11 */
12function fetchUsersAsAssociativeArray(): array
13{
14    // データベース接続情報 (実際の環境では、これらの値を環境変数などから安全に取得することを推奨します)
15    $dsn = 'mysql:host=localhost;dbname=test_db;charset=utf8mb4'; // データベース名 'test_db' は適宜変更してください
16    $username = 'root'; // データベースのユーザー名
17    $password = 'password'; // データベースのパスワード
18
19    $users = []; // 結果を格納する配列を初期化
20
21    try {
22        // 1. PDOインスタンスを作成し、データベースに接続
23        // エラーモードをPDO::ERRMODE_EXCEPTIONに設定することで、
24        // データベース操作中のエラーをPDOExceptionとして捕捉できます。
25        $pdo = new PDO($dsn, $username, $password, [
26            PDO::ATTR_ERRMODE            => PDO::ERRMODE_EXCEPTION,
27            PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC, // デフォルトのフェッチモードを連想配列に設定
28            PDO::ATTR_EMULATE_PREPARES   => false, // プリペアドステートメントのエミュレーションを無効化（セキュリティと性能向上）
29        ]);
30
31        // 2. 仮想的な 'users' テーブルを作成する（初回実行時のみ）
32        // 実際のアプリケーションでは、データベースマイグレーションツールを使用します。
33        $pdo->exec("
34            CREATE TABLE IF NOT EXISTS users (
35                id INT AUTO_INCREMENT PRIMARY KEY,
36                name VARCHAR(255) NOT NULL,
37                email VARCHAR(255) UNIQUE NOT NULL
38            );
39        ");
40
41        // 3. 仮想的なデータを挿入する（テーブルが空の場合のみ）
42        $stmtCheck = $pdo->query("SELECT COUNT(*) FROM users");
43        if ($stmtCheck->fetchColumn() == 0) {
44            $pdo->exec("INSERT INTO users (name, email) VALUES ('Alice', 'alice@example.com');");
45            $pdo->exec("INSERT INTO users (name, email) VALUES ('Bob', 'bob@example.com');");
46            $pdo->exec("INSERT INTO users (name, email) VALUES ('Charlie', 'charlie@example.com');");
47            echo "テストデータが挿入されました。\n";
48        }
49
50        // 4. SQLクエリを準備
51        // プリペアドステートメントを使用することで、SQLインジェクション攻撃を防ぎます。
52        $stmt = $pdo->prepare("SELECT id, name, email FROM users");
53
54        // 5. クエリを実行
55        $stmt->execute();
56
57        // 6. fetchAll メソッドを使用して、結果セットのすべての行を連想配列の配列として取得
58        // PDO::FETCH_ASSOC を引数に指定することで、結果のキーがカラム名となる連想配列形式で取得されます。
59        // 例: ['id' => 1, 'name' => 'Alice', 'email' => 'alice@example.com']
60        $users = $stmt->fetchAll(PDO::FETCH_ASSOC);
61
62    } catch (PDOException $e) {
63        // データベース接続またはクエリ実行中にエラーが発生した場合
64        echo "データベースエラーが発生しました: " . $e->getMessage() . "\n";
65        // 実際のアプリケーションでは、エラーログに詳細を記録するなど、より適切なエラー処理を行います。
66        return []; // エラー時は空の配列を返す
67    }
68
69    return $users; // 取得したユーザーデータの配列を返す
70}
71
72// 関数の実行と結果の表示
73$allUsers = fetchUsersAsAssociativeArray();
74
75if (!empty($allUsers)) {
76    echo "--- 取得したユーザーデータ ---\n";
77    foreach ($allUsers as $user) {
78        echo "ID: " . $user['id'] . ", 名前: " . $user['name'] . ", メール: " . $user['email'] . "\n";
79    }
80} else {
81    echo "ユーザーデータが見つかりませんでした。\n";
82}
83
84?>

PDOStatement::fetchAllメソッドは、PHPでデータベースを操作する際に、実行したSQLクエリの結果（結果セット）からすべての行を一度に取得するための便利な機能です。これはPDOStatementクラスに属しており、主にデータベースから複数のデータをまとめて取り出したいときに使用します。

引数$modeを指定することで、取得するデータの形式を細かく制御できます。特に、キーワードにもある「連想配列」として結果を受け取りたい場合は、PDO::FETCH_ASSOCを引数に指定します。このモードでは、データベースのカラム名が配列のキーとなり、対応する値がデータとして格納されます。例えば、idとnameのカラムがあれば、['id' => 1, 'name' => 'Alice']のような連想配列が各行に対して生成されます。

このメソッドの戻り値はarray型で、取得されたすべての行が要素として含まれる配列が返されます。PDO::FETCH_ASSOCを指定した場合は、連想配列の要素を持つ配列、つまり「連想配列の配列」となります。データが見つからない場合や、何らかの理由で結果が取得できなかった場合には、空の配列が返される仕組みです。

サンプルコードでは、データベースに接続してSQLクエリを実行した後、$stmt->fetchAll(PDO::FETCH_ASSOC)とすることで、usersテーブルの全データを連想配列の形で取得し、それぞれのユーザー情報を簡単に扱えるようにしています。システム開発においてデータベースからのデータ取得は頻繁に行われるため、このfetchAllメソッドは非常に重要な役割を果たします。