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

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

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

作成日: 更新日:

基本的な使い方

ATTR_STRINGIFY_FETCHES定数は、PHPがデータベースとのやり取りを扱うPDO(PHP Data Objects)クラスにおいて、データベースからデータを取り出す(フェッチする)際の振る舞いを制御する定数です。

この定数は、特にデータベースから取得した数値型のデータをPHPのスクリプト内でどのように扱うかを指定するために使用されます。PHPの数値型(整数型や浮動小数点型)は、その内部表現の制約から、データベースが扱う非常に大きな数値や高精度の数値を完全に表現しきれない場合があります。例えば、64ビットの大きな整数をデータベースから取得した場合、PHPの標準的な数値型では精度が失われる可能性があります。

ATTR_STRINGIFY_FETCHES定数をtrueに設定すると、PDOはデータベースから取得した全ての数値データを強制的に文字列として返します。これにより、PHPの数値型が持つ精度に関する問題を回避し、データベースからのデータを元のまま正確に扱うことが可能になります。

この設定は、PDOオブジェクトを初期化する際のオプションとして指定するか、またはPDO::setAttribute()メソッドを使用して既存のPDOインスタンスに対して動的に設定することができます。データベースから取得する数値データの精度が重要なアプリケーションにおいて、データの整合性を保つ上で非常に有用な機能を提供します。

構文(syntax)

1<?php
2$pdo = new PDO($dsn, $user, $password);
3$pdo->setAttribute(PDO::ATTR_STRINGIFY_FETCHES, true);
4?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

戻り値なし

戻り値はありません

サンプルコード

PHP PDO ATTR_STRINGIFY_FETCHES でデータ型を変換する

1<?php
2
3/**
4 * PDO::ATTR_STRINGIFY_FETCHES の使用例を示す関数。
5 * データベースからフェッチされる数値が文字列として扱われるようになることを示します。
6 *
7 * システムエンジニアを目指す初心者向けに、このオプションがデータ型に与える影響を
8 * 分かりやすく比較して解説します。
9 */
10function demonstratePdoAttrStringifyFetches(): void
11{
12    echo "--- PDO::ATTR_STRINGIFY_FETCHES デモンストレーション ---" . PHP_EOL . PHP_EOL;
13
14    // インメモリSQLiteデータベースを使用し、手軽に試せるようにします。
15    // これにより、ファイル作成などの手間なくデータベース操作が可能です。
16    $dsn = 'sqlite::memory:';
17
18    // PDO接続の共通オプションを定義します。
19    $commonOptions = [
20        PDO::ATTR_ERRMODE            => PDO::ERRMODE_EXCEPTION, // エラー発生時に例外をスローする設定
21        PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC,       // デフォルトのフェッチモードを連想配列に設定
22    ];
23
24    try {
25        // --------------------------------------------------------------------
26        // ケース1: PDO::ATTR_STRINGIFY_FETCHES を設定しない場合 (デフォルトの動作)
27        // --------------------------------------------------------------------
28        echo "=== ケース1: ATTR_STRINGIFY_FETCHES を設定しない場合 (デフォルト) ===" . PHP_EOL;
29        // デフォルトのオプションでPDO接続を作成します。
30        $pdoDefault = new PDO($dsn, null, null, $commonOptions);
31        setupDatabase($pdoDefault); // データベースのテーブルとサンプルデータを準備
32
33        // データを取得します。
34        $stmtDefault = $pdoDefault->query("SELECT id, name, age FROM users WHERE id = 1");
35        $userDefault = $stmtDefault->fetch();
36
37        echo "フェッチされたデータ (ATTR_STRINGIFY_FETCHES なし):" . PHP_EOL;
38        var_dump($userDefault);
39        echo "id の型: " . gettype($userDefault['id']) . PHP_EOL; // 数値型がそのまま保持されます
40        echo "age の型: " . gettype($userDefault['age']) . PHP_EOL . PHP_EOL; // 数値型がそのまま保持されます
41
42        // --------------------------------------------------------------------
43        // ケース2: PDO::ATTR_STRINGIFY_FETCHES を true に設定した場合
44        // --------------------------------------------------------------------
45        echo "=== ケース2: ATTR_STRINGIFY_FETCHES を true に設定した場合 ===" . PHP_EOL;
46        // ATTR_STRINGIFY_FETCHES オプションを追加します。
47        $optionsWithStringify = array_merge($commonOptions, [
48            PDO::ATTR_STRINGIFY_FETCHES => true, // フェッチされるすべての数値を文字列として扱う設定
49        ]);
50        // このオプションを適用してPDO接続を作成します。
51        $pdoWithStringify = new PDO($dsn, null, null, $optionsWithStringify);
52        setupDatabase($pdoWithStringify); // データベースのテーブルとサンプルデータを準備 (既に存在する場合は何もしません)
53
54        // データを取得します。
55        $stmtWithStringify = $pdoWithStringify->query("SELECT id, name, age FROM users WHERE id = 1");
56        $userWithStringify = $stmtWithStringify->fetch();
57
58        echo "フェッチされたデータ (ATTR_STRINGIFY_FETCHES => true):" . PHP_EOL;
59        var_dump($userWithStringify);
60        echo "id の型: " . gettype($userWithStringify['id']) . PHP_EOL; // 数値が文字列に変換されてフェッチされます
61        echo "age の型: " . gettype($userWithStringify['age']) . PHP_EOL . PHP_EOL; // 数値が文字列に変換されてフェッチされます
62
63        echo "この設定は、数値データを厳密に文字列として扱いたい場合に便利です。" . PHP_EOL;
64
65    } catch (PDOException $e) {
66        // データベース関連のエラーをキャッチして表示します。
67        echo "データベースエラーが発生しました: " . $e->getMessage() . PHP_EOL;
68    } catch (Exception $e) {
69        // その他の一般的なエラーをキャッチして表示します。
70        echo "一般的なエラーが発生しました: " . $e->getMessage() . PHP_EOL;
71    }
72}
73
74/**
75 * サンプルデータベースのテーブルを作成し、データを挿入する補助関数。
76 *
77 * @param PDO $pdo PDOデータベース接続オブジェクト
78 */
79function setupDatabase(PDO $pdo): void
80{
81    // テーブルが存在しない場合のみ作成します。
82    // SQLiteのINTEGER PRIMARY KEYはROWIDのエイリアスで、自動的にAUTOINCREMENTのようになります。
83    $pdo->exec("
84        CREATE TABLE IF NOT EXISTS users (
85            id   INTEGER PRIMARY KEY,
86            name TEXT NOT NULL,
87            age  INTEGER
88        );
89    ");
90
91    // テーブルにデータがまだ存在しない場合のみ、サンプルデータを挿入します。
92    $stmt = $pdo->query("SELECT COUNT(*) FROM users");
93    if ($stmt->fetchColumn() == 0) {
94        $pdo->exec("INSERT INTO users (id, name, age) VALUES (1, 'Alice', 30)");
95        $pdo->exec("INSERT INTO users (id, name, age) VALUES (2, 'Bob', 25)");
96        echo "※ サンプルデータを挿入しました。" . PHP_EOL . PHP_EOL;
97    }
98}
99
100// 上で定義したデモンストレーション関数を実行します。
101demonstratePdoAttrStringifyFetches();
102

PHPのPDO拡張機能には、データベースから取得するデータの型変換を制御する定数PDO::ATTR_STRINGIFY_FETCHESがあります。この定数は引数や戻り値を持たず、PDO接続オプションの一部として設定することでその挙動を決定します。

サンプルコードでは、この定数を設定した場合としない場合の比較を通してその効果を明確に示しています。通常、データベースのINTEGER型のような数値データは、PHPでフェッチされるとint型として扱われます。しかし、PDO::ATTR_STRINGIFY_FETCHEStrueに設定すると、データベースから取得される全ての数値データがPHPのstring型に変換されてフェッチされるようになります。

例えば、データベースのid列やage列が数値型であっても、このオプションが有効な場合は"1""30"といった文字列として取得されます。この機能は、PHP側で数値データの厳密な型を文字列として統一したい場合や、一部のデータベースドライバで数値の精度問題が発生する際に、文字列として一貫した処理を行いたい場合に役立ちます。これにより、予期しない型変換エラーを防ぎ、より堅牢なデータ処理を実装することが可能になります。

PDO::ATTR_STRINGIFY_FETCHESは、データベースから取得される数値データをPHP側で強制的に文字列として扱うためのオプションです。これをtrueに設定すると、idageのような数値型カラムの値も、すべて文字列としてフェッチされます。デフォルトでは数値は数値型のまま取得されるため、このオプションはデータの型の一貫性を求める場合に特に有用です。ただし、フェッチした数値データに対して直接計算を行う必要がある場合は、意図しない型変換エラーを避けるために、明示的な型キャストが必要になる点に注意が必要です。APIのレスポンスなどで常に文字列として出力したい場合に便利ですが、利用目的を明確にして適用してください。

関連コンテンツ