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

Copy
1<?php
2
3namespace Dom;
4
5class MyDocument extends \DOMDocument {
6    private $data = [];
7
8    public function __construct() {
9        parent::__construct();
10        $this->data = [
11            'key1' => 'value1',
12            'key2' => 'value2',
13        ];
14    }
15
16    // シリアライズ時に呼ばれるマジックメソッド
17    public function __sleep(): array
18    {
19        // シリアライズしたいプロパティのキーを配列で返す
20        // ここでは'data'プロパティのみをシリアライズする
21        return ['data'];
22    }
23
24    // アンシリアライズ時に呼ばれるマジックメソッド
25    public function __wakeup(): void
26    {
27        // アンシリアライズ後の初期化処理
28        // 必要に応じて行う
29        // 例: データベース接続の再確立など
30    }
31
32    public function getData(): array
33    {
34        return $this->data;
35    }
36
37    public function setData(array $data): void
38    {
39        $this->data = $data;
40    }
41}
42
43// 使用例
44$doc = new MyDocument();
45$doc->loadXML('<root><element>Example</element></root>');
46
47// シリアライズ
48$serialized = serialize($doc);
49
50// アンシリアライズ
51$unserialized = unserialize($serialized);
52
53// アンシリアライズされたオブジェクトのデータを確認
54if ($unserialized instanceof MyDocument) {
55    print_r($unserialized->getData());
56}

PHP 8 の Dom\Document クラスにおける __sleep メソッドは、オブジェクトがシリアライズされる際に自動的に呼び出されるマジックメソッドです。このメソッドは、オブジェクトを文字列形式に変換する serialize() 関数によって使用されます。

__sleep メソッドは引数を取りません。戻り値として、シリアライズしたいプロパティの名前を配列で返します。この配列に含まれないプロパティは、シリアライズ処理から除外されます。これにより、例えばデータベース接続などのシリアライズ不要なリソースを保存せずに、オブジェクトの状態を効率的に保存できます。

サンプルコードでは、MyDocument クラスが Dom\Document クラスを継承し、__sleep メソッドを実装しています。__sleep メソッドは、data プロパティのみをシリアライズ対象として指定しています。

__wakeup メソッドは、アンシリアライズ時に自動的に呼び出されるマジックメソッドです。シリアライズされたオブジェクトが unserialize() 関数によって復元される際に実行されます。このメソッド内で、データベース接続の再確立など、オブジェクトの初期化処理を行うことができます。サンプルコードでは、__wakeup メソッドは空ですが、必要に応じて初期化処理を記述できます。

この例では、MyDocument オブジェクトをシリアライズし、その後アンシリアライズしています。アンシリアライズされたオブジェクトの getData() メソッドを呼び出すことで、data プロパティが正しく復元されていることを確認できます。__sleep と __wakeup メソッドを適切に使用することで、オブジェクトのシリアライズとアンシリアライズを細かく制御し、より効率的で安全なデータ永続化を実現できます。