Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【PHP8.x】PDO::FETCH_BOTH定数の使い方

FETCH_BOTH定数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

FETCH_BOTH定数は、PHPのPDO(PHP Data Objects)拡張機能において、データベースから結果セットを取得する際のデータの形式を指定するために使用される定数です。この定数は、PDOStatementオブジェクトのfetch()fetchAll()といったメソッドの引数として利用されます。

具体的には、データベースから取得された各行のデータを、数値添字とカラム名(文字列キー)の両方をキーとする配列として返却するように指示します。例えば、SELECT id, name FROM usersというSQLクエリの結果を取得する際、PDO::FETCH_BOTHを指定すると、結果の配列$rowには$row[0]$row['id']、そして$row[1]$row['name']のように、同じデータに数値添字とカラム名の2つの異なる方法でアクセスできるようになります。

この特性は、取得したデータに数値添字でアクセスする必要がある場合と、カラム名でアクセスする方がコードの可読性が高まる場合の両方に対応したいときに特に便利です。データベースの設計変更があった際にも、カラム名でのアクセスであれば影響を受けにくいという側面や、動的にカラム名を決定してアクセスするといった柔軟な処理にも対応しやすくなります。PDO::FETCH_NUM(数値添字のみ)やPDO::FETCH_ASSOC(カラム名のみ)といった他のフェッチモードと比較して、両方のアクセス方法を提供することで、より多様なプログラミングシナリオに適応できる点が特徴です。

構文(syntax)

1<?php
2
3$dsn = 'mysql:host=localhost;dbname=testdb';
4$user = 'your_username';
5$password = 'your_password';
6
7try {
8    $pdo = new PDO($dsn, $user, $password);
9    $stmt = $pdo->query('SELECT id, name FROM users LIMIT 1');
10    $row = $stmt->fetch(PDO::FETCH_BOTH);
11    print_r($row);
12} catch (PDOException $e) {
13    echo 'エラー: ' . $e->getMessage();
14}
15
16?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

PDO::FETCH_BOTHは、PDOStatement::fetch()メソッドの引数として使用される定数です。この定数を指定すると、列名をキーとする連想配列と、数値インデックスをキーとする配列の両方で、取得した行のデータを配列として返します。

サンプルコード

PHP PDO FETCH_BOTHでのデータ取得

1<?php
2
3/**
4 * PDO::FETCH_BOTH を使用してデータベースからデータをフェッチするサンプル関数
5 *
6 * この関数はSQLiteインメモリデータベースを使用し、
7 * PDO::FETCH_BOTH フェッチモードで結果を取得する方法を示します。
8 * PDO::FETCH_BOTH は、カラム名をキーとする連想配列と、
9 * 0から始まる数値インデックスをキーとする配列の両方として行を返します。
10 * この定数自体は整数値 (int) です。
11 */
12function demonstratePdoFetchBoth(): void
13{
14    // SQLiteインメモリデータベースを使用。ファイルを作成しないため、手軽に試せる。
15    // 実際のアプリケーションでは、ファイルパスを指定して永続化することが多い。
16    $dsn = 'sqlite::memory:';
17    $user = null; // SQLiteではユーザー名とパスワードは通常不要
18    $password = null;
19
20    try {
21        // データベースに接続
22        // PDO::ATTR_ERRMODE を PDO::ERRMODE_EXCEPTION に設定することで、
23        // エラーが発生した場合に例外をスローするようにする。
24        $pdo = new PDO($dsn, $user, $password, [
25            PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
26            // デフォルトのフェッチモードはFETCH_ASSOCにしておく(後でFETCH_BOTHを明示的に指定するため)
27            PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC,
28        ]);
29
30        echo "データベースに接続しました。\n";
31
32        // テーブルが存在しない場合に作成
33        $pdo->exec("
34            CREATE TABLE IF NOT EXISTS users (
35                id INTEGER PRIMARY KEY AUTOINCREMENT,
36                name TEXT NOT NULL,
37                email TEXT NOT NULL UNIQUE
38            );
39        ");
40        echo "usersテーブルを作成しました(または既に存在します)。\n";
41
42        // データを挿入 (既に存在する場合は何もしないようにIGNOREを使用)
43        $stmt = $pdo->prepare("INSERT OR IGNORE INTO users (name, email) VALUES (?, ?)");
44        $stmt->execute(['Alice', 'alice@example.com']);
45        $stmt->execute(['Bob', 'bob@example.com']);
46        echo "サンプルデータを挿入しました(または既に存在します)。\n";
47
48        // PDO::FETCH_BOTH を使用してデータをフェッチ
49        echo "\n--- PDO::FETCH_BOTH でデータをフェッチ --- \n";
50        $stmt = $pdo->query("SELECT id, name, email FROM users");
51
52        // PDOStatement::fetch() の第1引数に PDO::FETCH_BOTH を指定
53        // PDO::FETCH_BOTH は定数であり、その値はint型です。
54        while ($row = $stmt->fetch(PDO::FETCH_BOTH)) {
55            echo "フェッチ結果 (PDO::FETCH_BOTH):\n";
56            print_r($row);
57            echo "--------------------\n";
58        }
59
60        echo "\nPDO::FETCH_BOTH は、カラム名と数値インデックスの両方でデータにアクセスできることを確認してください。\n";
61
62    } catch (PDOException $e) {
63        // データベース関連のエラーをキャッチ
64        echo "データベースエラーが発生しました: " . $e->getMessage() . "\n";
65    } catch (Exception $e) {
66        // その他のエラーをキャッチ
67        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
68    }
69}
70
71// 関数を実行して PDO::FETCH_BOTH の動作を示す
72demonstratePdoFetchBoth();
73
74?>

PHPのPDO::FETCH_BOTHは、データベースからデータを取得する際に使用する定数です。PHP 8のPDOクラスに属し、引数を取らず、その値は整数型(int)の定数値そのものです。この定数は、PDOStatement::fetch()などのメソッドに指定することで、データベースから取り出すデータの形式を決定します。

PDO::FETCH_BOTHを指定すると、取得したデータベースの1行データが、カラム名(例: 'name')をキーとする連想配列と、0から始まる数値インデックス(例: 0, 1, 2)をキーとする配列の両方を含む形式で返されます。これにより、開発者はデータのカラム名とインデックス、どちらの方法でも柔軟にアクセスできるようになります。

サンプルコードでは、まずSQLiteインメモリデータベースに接続し、「users」テーブルの作成とデータの挿入を行います。その後、SELECT文でデータを取得する際に$stmt->fetch(PDO::FETCH_BOTH)と指定しています。これにより、whileループ内で取り出される$row変数は、カラム名と数値インデックスの双方でアクセス可能な配列として出力され、その挙動を確認できます。この定数は、データへのアクセス方法の選択肢を増やしたい場合に特に便利です。

PDO::FETCH_BOTHは、データベースから取得したデータをカラム名(連想配列)と数値インデックス(配列)の両方でアクセスできる便利なフェッチモードです。しかし、どちらか片方で十分な場合は、メモリ消費の観点からPDO::FETCH_ASSOCやPDO::FETCH_NUMを検討することも重要です。

サンプルでは手軽なSQLiteインメモリデータベースを使用していますが、プログラム終了時にデータは失われるため、実際のアプリケーションではファイルパス指定や外部データベースへの接続が必要です。

また、PDO::ATTR_ERRMODEをPDO::ERRMODE_EXCEPTIONに設定することは、データベースエラーを例外として捕捉し、適切に処理するための重要な設定です。常にエラーハンドリングを意識しましょう。データを挿入する際にprepareexecuteを使っているのは、SQLインジェクション攻撃を防ぐためのセキュリティ対策です。SQL文に直接変数を埋め込まず、必ずプリペアドステートメントを使用してください。

PHP PDO FETCH_BOTHで両方取得する

1<?php
2
3/**
4 * PDO::FETCH_BOTH を使用してデータベースからデータを取得する方法を示すサンプルコードです。
5 *
6 * PDO::FETCH_BOTH は、PDOStatement::fetch() メソッドの引数として使用され、
7 * 結果セットの行を数値添字とカラム名(連想配列のキー)の両方でアクセスできるようにします。
8 *
9 * このコードは、SQLiteのインメモリデータベースを使用するため、外部のデータベース設定なしで単体で動作します。
10 */
11function demonstratePdoFetchBoth(): void
12{
13    // データベース接続情報 (SQLiteのインメモリデータベースを使用)
14    // 'sqlite::memory:' は、メモリ上に一時的なデータベースを作成することを意味します。
15    $dsn = 'sqlite::memory:';
16    $user = null; // SQLiteではユーザー名とパスワードは通常不要です。
17    $password = null;
18
19    try {
20        // 1. データベースへの接続
21        // PDO (PHP Data Objects) は、PHPから様々なデータベースに統一された方法でアクセスするための拡張機能です。
22        $pdo = new PDO($dsn, $user, $password);
23        // エラー発生時に例外をスローするように設定 (開発中にエラーを発見しやすくなります)。
24        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
25
26        echo "データベースに接続しました。\n\n";
27
28        // 2. テスト用テーブルの作成とデータの挿入
29        // ユーザー情報を保持するテーブル 'users' を作成します。
30        $pdo->exec("
31            CREATE TABLE IF NOT EXISTS users (
32                id INTEGER PRIMARY KEY AUTOINCREMENT,
33                name TEXT NOT NULL,
34                email TEXT UNIQUE NOT NULL
35            )
36        ");
37        // テストデータを挿入します。
38        $pdo->exec("INSERT INTO users (name, email) VALUES ('Alice', 'alice@example.com')");
39        $pdo->exec("INSERT INTO users (name, email) VALUES ('Bob', 'bob@example.com')");
40
41        echo "テストデータを作成し、挿入しました。\n\n";
42
43        // 3. データの選択クエリを準備
44        // プリペアドステートメントを使用すると、SQLインジェクション攻撃を防ぎ、クエリを効率的に実行できます。
45        $stmt = $pdo->prepare("SELECT id, name, email FROM users WHERE id = :id");
46
47        // 4. クエリの実行
48        // プレースホルダ `:id` に値をバインドしてクエリを実行します。
49        // ここではIDが1のユーザーの情報を取得します。
50        $stmt->execute([':id' => 1]);
51
52        // 5. PDO::FETCH_BOTH を使用して結果をフェッチ
53        // fetch() メソッドに PDO::FETCH_BOTH を渡すことで、取得する行の形式を指定します。
54        // 結果は、数値添字 (例: $row[0]) とカラム名 (例: $row['id']) の両方でアクセス可能です。
55        $row = $stmt->fetch(PDO::FETCH_BOTH);
56
57        if ($row) {
58            echo "--- PDO::FETCH_BOTH で取得したデータ --- \n";
59            echo "取得した行は、数値添字と連想配列のキーの両方でアクセスできます。\n\n";
60
61            // 数値添字でデータにアクセス
62            echo "ID (数値添字): " . $row[0] . "\n";
63            echo "Name (数値添字): " . $row[1] . "\n";
64            echo "Email (数値添字): " . $row[2] . "\n\n";
65
66            // カラム名(連想配列のキー)でデータにアクセス
67            echo "ID (カラム名): " . $row['id'] . "\n";
68            echo "Name (カラム名): " . $row['name'] . "\n";
69            echo "Email (カラム名): " . $row['email'] . "\n";
70
71            echo "\n--- 取得した行の全内容 (print_rで確認) ---\n";
72            // print_r() は、配列の構造を人間が読みやすい形式で表示するために便利です。
73            print_r($row);
74        } else {
75            echo "指定されたIDのデータが見つかりませんでした。\n";
76        }
77
78    } catch (PDOException $e) {
79        // データベース関連のエラーが発生した場合の処理
80        echo "データベースエラーが発生しました: " . $e->getMessage() . "\n";
81    } finally {
82        // データベース接続を閉じる
83        // PHPスクリプト終了時に自動的に閉じられることが多いですが、明示的にnullにすることも可能です。
84        $pdo = null;
85        echo "\nデータベース接続を閉じました。\n";
86    }
87}
88
89// 上記のサンプルコードを実行します。
90demonstratePdoFetchBoth();
91

PDO::FETCH_BOTHは、PHPでデータベース操作を行うための拡張機能であるPDOが提供する定数の一つです。この定数は、データベースからデータを取得する際に使用するPDOStatement::fetch()メソッドの引数として指定され、結果の行をどのような形式で受け取るかを制御します。

PDO::FETCH_BOTHを指定すると、データベースから取得した1行のデータが、数値添字(例: $row[0]) とカラム名(連想配列のキー、例: $row['id']) の両方でアクセス可能な配列として返されます。これにより、データの参照方法に柔軟性を持たせることができます。この定数自体は引数を取らず、内部的に特定の整数値(int型)を持ちます。

サンプルコードでは、まずSQLiteのインメモリデータベースに接続し、テスト用のテーブルを作成してデータを挿入しています。その後、特定のユーザー情報を取得するSELECTクエリを実行し、$stmt->fetch(PDO::FETCH_BOTH)を使用して結果の行をフェッチしています。取得された$row変数は、数値添字とカラム名の両方を使ってデータにアクセスできるため、それぞれの方法でID、名前、メールアドレスが出力され、PDO::FETCH_BOTHの挙動が具体的に確認できます。

PDO::FETCH_BOTHは、数値添字とカラム名の両方でデータにアクセスできますが、同じデータが配列に二重に格納されるため、メモリ消費が増える点に注意が必要です。大量のデータを扱う場合は、PDO::FETCH_ASSOCPDO::FETCH_NUMなど、必要な形式のみを返すフェッチモードの選択を検討してください。サンプルコードで示すプリペアドステートメントの利用は、SQLインジェクション対策として必須であり、常に実践してください。PDO::ATTR_ERRMODEPDO::ERRMODE_EXCEPTIONに設定することで、データベースエラーを例外として捕捉し、開発中のデバッグを容易にします。実運用環境では、データベース接続情報やエラーメッセージの取り扱いに十分注意し、適切なセキュリティ対策を講じることが重要です。

関連コンテンツ