【PHP8.x】Dom\Entity::__wakeup()メソッドの使い方

Copy
1<?php
2
3/**
4 * データベース接続を模倣し、__wakeup の動作を説明するクラス
5 */
6class DatabaseConnection
7{
8    /** @var string データベース接続情報 */
9    private string $dsn;
10
11    /** @var ?string 接続状態を示すプロパティ */
12    private ?string $connectionStatus = null;
13
14    /**
15     * コンストラクタ
16     * オブジェクト生成時にデータベースへ接続します。
17     *
18     * @param string $dsn
19     */
20    public function __construct(string $dsn)
21    {
22        $this->dsn = $dsn;
23        $this->connect();
24    }
25
26    /**
27     * __sleep マジックメソッド
28     * serialize() が実行される直前に呼び出されます。
29     * シリアライズしたいプロパティ名の配列を返す必要があります。
30     * ここでは、接続状態は保存せず、接続情報(dsn)のみを保存対象とします。
31     *
32     * @return string[]
33     */
34    public function __sleep(): array
35    {
36        echo "-> __sleep() が呼び出されました。接続を一時的に閉じます。" . PHP_EOL;
37        $this->connectionStatus = null; // 接続状態をクリア
38        return ['dsn']; // 'dsn' プロパティのみシリアライズする
39    }
40
41    /**
42     * __wakeup マジックメソッド
43     * unserialize() が実行された直後、オブジェクトが復元された際に呼び出されます。
44     * データベース接続の再確立など、リソースの再初期化処理をここで行います。
45     *
46     * @return void
47     */
48    public function __wakeup(): void
49    {
50        echo "-> __wakeup() が呼び出されました。データベースに再接続します。" . PHP_EOL;
51        $this->connect(); // 接続を再確立する
52    }
53
54    /**
55     * データベースへの接続を模倣するメソッド
56     */
57    private function connect(): void
58    {
59        $this->connectionStatus = "Connected to " . $this->dsn;
60        echo "データベース接続が確立しました。({$this->connectionStatus})" . PHP_EOL;
61    }
62
63    /**
64     * 現在の接続状態を取得します。
65     *
66     * @return string
67     */
68    public function getStatus(): string
69    {
70        return $this->connectionStatus ?? 'Not Connected';
71    }
72}
73
74// 1. オブジェクトを生成します (__construct が呼ばれます)
75echo "1. 新しいオブジェクトを生成します..." . PHP_EOL;
76$db = new DatabaseConnection("mysql:host=localhost;dbname=mydb");
77echo "生成後の状態: " . $db->getStatus() . PHP_EOL . PHP_EOL;
78
79// 2. オブジェクトをシリアライズ(文字列化)します (__sleep が呼ばれます)
80echo "2. オブジェクトをシリアライズします..." . PHP_EOL;
81$serializedDb = serialize($db);
82echo "シリアライズされたデータ: " . $serializedDb . PHP_EOL . PHP_EOL;
83
84// 3. シリアライズされた文字列からオブジェクトを復元します (__wakeup が呼ばれます)
85echo "3. オブジェクトを復元します..." . PHP_EOL;
86$unserializedDb = unserialize($serializedDb);
87echo "復元後の状態: " . $unserializedDb->getStatus() . PHP_EOL;
88
89?>

__wakeupメソッドは、unserialize()関数によって文字列からオブジェクトが復元された直後に、自動的に呼び出されるPHPの「マジックメソッド」です。このメソッドの主な目的は、オブジェクトが復元された際に必要な初期化処理や、失われたリソースの再確立を行うことです。例えば、シリアライズの過程で切断されたデータベース接続やファイルハンドルなどを、再び利用可能な状態に戻す処理を記述します。

サンプルコードのDatabaseConnectionクラスでは、serialize()関数でオブジェクトを文字列化する際に、データベース接続が一時的に切断されます。その後、unserialize()関数でオブジェクトが復元されると、__wakeupメソッドが自動で実行され、内部でデータベースへの再接続処理を呼び出します。これにより、オブジェクトは再びデータベースと通信できる正常な状態に戻ります。

このように、__wakeupはオブジェクトの状態を完全に復元するための重要な役割を担います。このメソッドは引数を受け取らず、オブジェクトの内部状態を整えるための手続きであるため、特定の値を返す必要はなく、戻り値はvoidとなります。