【PHP8.x】__wakeupメソッドの使い方

Copy
1<?php
2
3class MyDOMDocumentFragment extends DOMDocumentFragment {
4    private $data;
5
6    public function __construct() {
7        parent::__construct();
8        $this->data = "初期データ";
9    }
10
11    public function setData(string $data): void {
12        $this->data = $data;
13    }
14
15    public function getData(): string {
16        return $this->data;
17    }
18
19    // __wakeup メソッドを定義して、デシリアライズ時の処理を制御
20    public function __wakeup() {
21        // デシリアライズ後にデータをリセット
22        $this->data = "デシリアライズ後のデータ";
23    }
24}
25
26// MyDOMDocumentFragment のインスタンスを作成
27$fragment = new MyDOMDocumentFragment();
28$fragment->setData("シリアライズ前のデータ");
29
30// シリアライズ
31$serialized = serialize($fragment);
32
33// デシリアライズ
34$unserialized = unserialize($serialized);
35
36// データを確認
37echo "シリアライズ前のデータ: " . $fragment->getData() . PHP_EOL; // シリアライズ前のデータ: シリアライズ前のデータ
38echo "デシリアライズ後のデータ: " . $unserialized->getData() . PHP_EOL; // デシリアライズ後のデータ: デシリアライズ後のデータ
39
40?>

このサンプルコードは、PHPのDOMDocumentFragmentクラスを拡張したMyDOMDocumentFragmentクラスにおいて、マジックメソッド__wakeup()の動作を解説するものです。__wakeup()メソッドは、オブジェクトがunserialize()関数によってデシリアライズされる際に自動的に呼び出される特殊なメソッドです。引数はなく、戻り値もありません（void）。

MyDOMDocumentFragmentクラスは、内部に $data というプライベートなプロパティを持ち、コンストラクタで初期値を設定しています。setData()メソッドで $data の値を変更でき、getData()メソッドでその値を取得できます。

このサンプルでは、MyDOMDocumentFragmentのインスタンスを生成し、setData()メソッドで初期値を設定した後、serialize()関数でシリアライズしています。その後、unserialize()関数でデシリアライズしています。

__wakeup()メソッドが定義されているため、デシリアライズ時に自動的に呼び出されます。この例では、__wakeup()メソッド内で $data プロパティの値を "デシリアライズ後のデータ" にリセットしています。

実行結果から、シリアライズ前の $data の値と、デシリアライズ後の $data の値が異なることがわかります。これは、__wakeup()メソッドがデシリアライズ時に実行され、$data の値を変更したためです。このように、__wakeup()メソッドを使うことで、デシリアライズ後のオブジェクトの状態を制御することができます。例えば、データベース接続の再確立や、オブジェクトの初期化処理などを行うことができます。

Copy
1<?php
2
3class MyDOMDocumentFragment extends DOMDocumentFragment {
4    private $data;
5
6    public function __construct() {
7        parent::__construct();
8        $this->data = "初期データ";
9    }
10
11    public function setData(string $data): void {
12        $this->data = $data;
13    }
14
15    public function getData(): string {
16        return $this->data;
17    }
18
19    public function __sleep(): array {
20        // シリアライズするプロパティを配列で指定
21        return ['data'];
22    }
23
24    public function __wakeup(): void {
25        // オブジェクトの復元時に実行される
26        echo "オブジェクトが復元されました。\n";
27        // 必要に応じて初期化処理を行う
28        if ($this->data === null) {
29            $this->data = "復元後の初期データ";
30        }
31    }
32}
33
34// MyDOMDocumentFragmentのインスタンスを作成
35$fragment = new MyDOMDocumentFragment();
36$fragment->setData("重要なデータ");
37
38// シリアライズ
39$serialized = serialize($fragment);
40
41// アンシリアライズ
42$unserialized = unserialize($serialized);
43
44// データの確認
45echo "データ: " . $unserialized->getData() . "\n"; // "データ: 重要なデータ" と出力される
46
47?>

PHP 8 の DOMDocumentFragment クラスにおける __wakeup メソッドは、オブジェクトのアンシリアライズ（復元）時に自動的に実行される特別なメソッドです。このメソッドは引数を取らず、戻り値もありません（void）。

このサンプルコードでは、DOMDocumentFragment を継承した MyDOMDocumentFragment クラスを定義し、__wakeup メソッドを実装しています。__wakeup メソッド内で、オブジェクトが復元されたことを示すメッセージを出力し、必要に応じて初期化処理を行っています。具体的には、$data プロパティが null の場合に、デフォルト値を設定しています。

__sleep メソッドは、オブジェクトがシリアライズされる際に呼び出され、シリアライズするプロパティのリストを返します。この例では、$data プロパティのみがシリアライズされます。

サンプルコードでは、まず MyDOMDocumentFragment のインスタンスを作成し、setData メソッドで $data プロパティに値を設定します。その後、serialize 関数でオブジェクトをシリアライズし、unserialize 関数でアンシリアライズします。アンシリアライズされたオブジェクトの $data プロパティの値を確認することで、オブジェクトが正しく復元されていることを確認できます。__wakeup メソッドは、unserialize 関数が呼び出されたタイミングで実行され、指定された初期化処理を行います。この例では、「オブジェクトが復元されました。」というメッセージが出力されます。