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

Copy
1<?php
2
3/**
4 * PDO::FETCH_SERIALIZE 定数を使用して、データベースに保存された
5 * シリアライズされたPHPオブジェクトをデシリアライズして取得するサンプルコード。
6 *
7 * この定数は、PDO::fetch() メソッドの$mode引数に指定し、
8 * 主にPDO::FETCH_CLASSなどのオブジェクトとしてデータを取得するモードと組み合わせて使用されます。
9 * データベースのカラムにシリアライズされたデータが保存されている場合に、
10 * そのデータをPHPのオブジェクトとして自動的にデシリアライズしてマッピングします。
11 */
12try {
13    // インメモリのSQLiteデータベースに接続し、単体で動作可能にする
14    $pdo = new PDO('sqlite::memory:');
15    $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION); // エラー発生時に例外をスローするよう設定
16
17    // データベースから取得するデータをマッピングするためのクラスを定義
18    // このクラスのプロパティ名がテーブルのカラム名に対応します
19    class MyData
20    {
21        public int $id;
22        public string $name;
23        // シリアライズされたオブジェクトが格納されるプロパティ
24        // PDO::FETCH_SERIALIZE により、このプロパティにデシリアライズされたオブジェクトが設定されます
25        public object $additionalInfo;
26    }
27
28    // テスト用のテーブルを作成
29    $pdo->exec("CREATE TABLE items (
30        id INTEGER PRIMARY KEY AUTOINCREMENT,
31        name TEXT NOT NULL,
32        additionalInfo BLOB -- シリアライズされたデータを格納するためのカラム
33    )");
34
35    // データベースに保存するカスタムオブジェクトを作成
36    $infoObject = (object) [
37        'version' => 1.0,
38        'status' => 'active',
39        'tags' => ['php', 'pdo', 'serialize'],
40    ];
41
42    // カスタムオブジェクトをシリアライズしてデータベースに挿入
43    $stmt = $pdo->prepare("INSERT INTO items (name, additionalInfo) VALUES (:name, :additionalInfo)");
44    $stmt->execute([
45        ':name' => 'Sample Item',
46        ':additionalInfo' => serialize($infoObject) // オブジェクトをシリアライズして保存
47    ]);
48
49    echo "データがデータベースに挿入されました。\n\n";
50
51    // データベースからデータを取得
52    // PDO::FETCH_CLASS と PDO::FETCH_SERIALIZE を組み合わせて使用します。
53    // - PDO::FETCH_CLASS は結果をMyDataクラスのインスタンスとして取得します。
54    // - PDO::FETCH_SERIALIZE は、MyDataクラスのadditionalInfoプロパティに
55    //   データベースのadditionalInfoカラムからシリアライズされた文字列がマップされる際に、
56    //   自動的にデシリアライズしてPHPオブジェクトとしてプロパティに設定します。
57    $stmt = $pdo->prepare("SELECT id, name, additionalInfo FROM items WHERE name = :name");
58    $stmt->execute([':name' => 'Sample Item']);
59
60    // フェッチモードを設定: MyDataクラスのインスタンスとして取得し、シリアライズデータをデシリアライズする
61    $stmt->setFetchMode(PDO::FETCH_CLASS | PDO::FETCH_SERIALIZE, MyData::class);
62
63    /** @var MyData|false $item */
64    $item = $stmt->fetch();
65
66    if ($item) {
67        echo "データベースからデータを取得しました:\n";
68        echo "ID: " . $item->id . "\n";
69        echo "名前: " . $item->name . "\n";
70        echo "追加情報 (デシリアライズされたオブジェクト): \n";
71        var_dump($item->additionalInfo); // additionalInfoがPHPオブジェクトになっていることを確認
72
73        // 取得したオブジェクトのプロパティにアクセス
74        echo "  バージョン: " . $item->additionalInfo->version . "\n";
75        echo "  ステータス: " . $item->additionalInfo->status . "\n";
76        echo "  タグ: " . implode(', ', $item->additionalInfo->tags) . "\n";
77    } else {
78        echo "データが見つかりませんでした。\n";
79    }
80
81} catch (PDOException $e) {
82    echo "データベースエラーが発生しました: " . $e->getMessage() . "\n";
83} catch (Exception $e) {
84    echo "一般エラーが発生しました: " . $e->getMessage() . "\n";
85}
86

PHP 8のPDO::FETCH_SERIALIZEは、データベースにシリアライズされたPHPオブジェクトが保存されている場合に、データを取得する際に自動的にデシリアライズしてPHPオブジェクトとして扱うための定数です。この定数自体は引数を取りませんが、戻り値は整数値であり、PDOのデータフェッチモードとして内部的に使用されます。

主にPDO::fetch()やPDOStatement::setFetchMode()メソッドのモード引数に、PDO::FETCH_CLASSなどのオブジェクトフェッチモードと組み合わせて指定します。この定数を指定すると、データベースのカラムにPHPのserialize()関数で文字列化されたデータが格納されている場合、その文字列を自動的にunserialize()関数でデシリアライズし、対応するPHPクラスのプロパティへPHPオブジェクトとして設定します。

これにより、開発者は手動でデシリアライズ処理を行う手間が省け、データベースから取得したデータを透過的にオブジェクトとして利用できるようになります。サンプルコードでは、MyDataクラスのadditionalInfoプロパティが、データベースにシリアライズされて保存されたオブジェクトを、PDO::FETCH_CLASS | PDO::FETCH_SERIALIZEのモード設定によって、自動的にPHPオブジェクトとして受け取る様子を示しています。

Copy
1<?php
2
3/**
4 * PDO::FETCH_SERIALIZE の使用例
5 *
6 * この定数は、データベースから取得したシリアライズされた文字列をオブジェクトに変換することを意図しています。
7 *
8 * 【重要】PHP 8.1 以降では非推奨となり、実行時に E_DEPRECATED 警告が出ます。
9 *          また、内部的に PDO::FETCH_PROPS_LATE にフォールバックするため、
10 *          通常は意図したオブジェクトのデシリアライズは行われません（生のシリアライズ済み文字列が返されるなど）。
11 *          PHP 9.0 でこの定数は完全に削除されました。
12 *
13 * システムエンジニアを目指す初心者の方は、この定数の代わりに PDO::FETCH_CLASS や PDO::FETCH_OBJ の利用を強く推奨します。
14 */
15function fetchSerializedObjectExample(): void
16{
17    // データベース接続設定 (SQLiteのインメモリDBを使用)
18    try {
19        $pdo = new PDO('sqlite::memory:');
20        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
21    } catch (PDOException $e) {
22        echo "データベース接続エラー: " . $e->getMessage() . "\n";
23        return;
24    }
25
26    // オブジェクトの定義
27    // このクラスは、シリアライズ/デシリアライズの対象となります。
28    class MyData
29    {
30        public string $name;
31        public int $value;
32
33        public function __construct(string $name = '', int $value = 0)
34        {
35            $this->name = $name;
36            $this->value = $value;
37        }
38    }
39
40    // テーブル作成
41    $pdo->exec("CREATE TABLE IF NOT EXISTS serialized_objects (
42        id INTEGER PRIMARY KEY,
43        data TEXT
44    )");
45
46    // オブジェクトを準備
47    $originalObject = new MyData("Sample Item", 123);
48
49    // オブジェクトをシリアライズしてデータベースに保存できる形式にする
50    $serializedData = serialize($originalObject);
51
52    // シリアライズされたデータをデータベースに挿入
53    $stmt = $pdo->prepare("INSERT INTO serialized_objects (data) VALUES (?)");
54    $stmt->execute([$serializedData]);
55    echo "シリアライズされたデータをデータベースに挿入しました。\n";
56
57    // データベースからデータを取得
58    $stmt = $pdo->query("SELECT data FROM serialized_objects WHERE id = 1");
59
60    // PDO::FETCH_SERIALIZE を使用して、取得したデータをオブジェクトとしてデシリアライズ試行
61    // PHP 8.1 以降では、この設定は期待通りに動作せず、警告とフォールバックが発生します。
62    $stmt->setFetchMode(PDO::FETCH_SERIALIZE); 
63
64    $fetchedObject = $stmt->fetch();
65
66    echo "\n--- 取得結果の確認 ---\n";
67    if ($fetchedObject instanceof MyData) {
68        // このパスはPHP 8.0でPDO::FETCH_SERIALIZEが意図通りに動作した場合に実行されます。
69        echo "デシリアライズされたオブジェクト:\n";
70        echo "  Name: " . $fetchedObject->name . "\n";
71        echo "  Value: " . $fetchedObject->value . "\n";
72        echo "  Type: " . get_class($fetchedObject) . "\n";
73    } elseif ($fetchedObject instanceof stdClass && isset($fetchedObject->data)) {
74        // このパスはPHP 8.1以降でPDO::FETCH_SERIALIZEがPDO::FETCH_PROPS_LATEにフォールバックした場合に実行されます。
75        // デシリアライズは行われず、シリアライズされた文字列がそのまま取得されます。
76        echo "取得されたのは stdClass オブジェクトです（PHP 8.1+ のフォールバック挙動の可能性が高い）。\n";
77        echo "  カラム 'data' の内容: " . $fetchedObject->data . "\n";
78        echo "  元のオブジェクト型にはデシリアライズされていません。\n";
79        // 必要であれば、手動でデシリアライズすることも可能です
80        $manuallyDeserialized = unserialize($fetchedObject->data);
81        if ($manuallyDeserialized instanceof MyData) {
82            echo "  （手動デシリアライズ後）Name: " . $manuallyDeserialized->name . "\n";
83        }
84    } else {
85        echo "オブジェクトの取得に失敗したか、予期しない型でした。\n";
86        var_dump($fetchedObject);
87    }
88    echo "--------------------\n";
89}
90
91// 関数の実行
92fetchSerializedObjectExample();

PDO::FETCH_SERIALIZEは、データベースから取得したシリアライズ（直列化）された文字列データを、PHPのオブジェクトとして自動的にデシリアライズ（非直列化）するために使われる定数です。この定数自体は引数を持ちませんが、戻り値は整数値で、PDOStatement::setFetchModeメソッドなどに渡して、データベースからデータを取得する際の形式を指定します。

しかし、PHP 8.1以降ではこの定数は非推奨となり、使用するとE_DEPRECATED警告が発生します。実際には内部的にPDO::FETCH_PROPS_LATEという別のモードにフォールバックするため、期待通りのオブジェクトへのデシリアライズは行われず、シリアライズされた生データがstdClassオブジェクトとして返されることがほとんどです。PHP 9.0でこの定数は完全に削除されました。

このサンプルコードでは、MyDataクラスのオブジェクトをシリアライズしてデータベースに保存し、PDO::FETCH_SERIALIZEを用いてデータ取得を試みる例を示しています。PHP 8.0環境ではMyDataオブジェクトとしてデシリアライズされる可能性を示唆していますが、PHP 8.1以降ではstdClassオブジェクトとして元の文字列データが返され、手動でのデシリアライズが必要となる挙動を具体的に説明しています。

システムエンジニアを目指す初心者の方には、この非推奨で挙動が複雑な定数ではなく、よりシンプルで安定したPDO::FETCH_CLASSやPDO::FETCH_OBJといった定数の利用を強くお勧めします。