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

Copy
1<?php
2
3class MyDOMElement extends DOMElement {
4    private $data;
5
6    public function __construct(string $name, string $value = '', string $namespaceURI = '') {
7        parent::__construct($name, $value, $namespaceURI);
8        $this->data = ['key1' => 'value1', 'key2' => 'value2']; // 例としてデータを追加
9    }
10
11    public function getData(): array {
12        return $this->data;
13    }
14
15    public function __sleep(): array {
16        // シリアライズするプロパティのキーを配列で返す
17        // 'data' プロパティのみシリアライズする例
18        return ['data'];
19    }
20
21    public function __wakeup(): void {
22        // シリアライズされたオブジェクトがアンシリアライズされた後に実行される処理
23        // ここで必要な初期化処理を行う
24        echo "MyDOMElement オブジェクトがアンシリアライズされました。\n";
25    }
26}
27
28// DOMDocumentの作成
29$dom = new DOMDocument();
30
31// MyDOMElementの作成
32$element = new MyDOMElement('myElement');
33$dom->appendChild($element);
34
35// シリアライズ
36$serialized = serialize($element);
37
38// シリアライズされたデータの表示（確認用）
39echo "シリアライズされたデータ: " . $serialized . "\n";
40
41// アンシリアライズ
42$unserialized = unserialize($serialized);
43
44// アンシリアライズされたオブジェクトがMyDOMElementのインスタンスであるか確認
45if ($unserialized instanceof MyDOMElement) {
46    // アンシリアライズされたオブジェクトのデータの表示
47    print_r($unserialized->getData());
48}
49
50?>

このサンプルコードは、PHP 8のDOMElementクラスを拡張したMyDOMElementクラスにおける__sleepメソッドの使い方を示しています。__sleepメソッドは、オブジェクトがシリアライズ（文字列化）される際に自動的に呼び出される特殊なメソッドです。

通常、オブジェクトをserialize()関数でシリアライズすると、オブジェクトの全てのプロパティが保存されます。しかし、__sleepメソッドを定義することで、シリアライズ対象とするプロパティを制御できます。__sleepメソッドは引数を取りません。そして、シリアライズしたいプロパティの名前を要素として持つ配列を返します。サンプルコードでは、MyDOMElementクラスの__sleepメソッドは、dataプロパティのみをシリアライズ対象として指定しています。

__wakeupメソッドは、シリアライズされたオブジェクトがunserialize()関数によってアンシリアライズ（オブジェクトに戻される）された後に自動的に呼び出されるメソッドです。このメソッドを使うことで、アンシリアライズ後に必要な初期化処理を実行できます。サンプルコードでは、アンシリアライズされた際にメッセージを表示する処理を実装しています。

このコードでは、まずMyDOMElementクラスのインスタンスを作成し、serialize()関数でシリアライズしています。その後、unserialize()関数でアンシリアライズし、getData()メソッドでdataプロパティの内容を表示しています。__sleepメソッドでdataプロパティのみをシリアライズするように指定しているため、シリアライズ/アンシリアライズの過程で他のプロパティは保存されません。この例から、__sleepメソッドを利用して、オブジェクトの状態を効率的に保存・復元できることがわかります。sleepメソッドが効かない場合は、このメソッドが正しく実装されているか確認してください。

Copy
1<?php
2
3class MyElement extends DOMElement {
4    private string $data;
5
6    public function __construct(string $prefix, string $name, string $namespaceURI = '') {
7        parent::__construct($prefix, $name, $namespaceURI);
8        $this->data = "Some important data";
9    }
10
11    /**
12     * serialize 時に保存するプロパティの配列を返す
13     * @return array
14     */
15    public function __sleep(): array {
16        // data プロパティは保存しない
17        return array('prefix', 'localName', 'namespaceURI');
18    }
19
20    public function __wakeup(): void {
21        // 必要に応じて、serialize されなかったプロパティを再初期化する
22        $this->data = "Data reinitialized after unserialization";
23    }
24
25    public function getData(): string {
26        return $this->data;
27    }
28}
29
30// DOMDocumentの作成
31$dom = new DOMDocument();
32
33// MyElementを登録
34$dom->registerNodeClass('DOMElement', 'MyElement');
35
36// ルート要素を作成
37$root = $dom->createElement('root');
38$dom->appendChild($root);
39
40// MyElementのインスタンスを作成し、追加
41$myElement = new MyElement('my', 'element');
42$root->appendChild($myElement);
43
44// データの確認
45echo "Before serialization: " . $myElement->getData() . "\n"; // 出力: Before serialization: Some important data
46
47// シリアライズ
48$serialized = serialize($dom);
49
50// アンシリアライズ
51$unserializedDom = unserialize($serialized);
52
53// アンシリアライズ後のデータの確認
54/** @var MyElement $unserializedMyElement */
55$unserializedMyElement = $unserializedDom->getElementsByTagNameNS('*', 'element')->item(0);
56echo "After unserialization: " . $unserializedMyElement->getData() . "\n"; // 出力: After unserialization: Data reinitialized after unserialization

DOMElementクラスの__sleepメソッドは、オブジェクトがシリアライズ（serialize()関数による文字列化）される際に、どのプロパティを保存するかを定義するために使用されるマジックメソッドです。このメソッドは引数を取らず、シリアライズするプロパティの名前を要素とする配列を返します。

サンプルコードでは、DOMElementを継承したMyElementクラスで__sleepメソッドを実装しています。MyElementクラスは$dataというプロパティを持っていますが、__sleepメソッドは'prefix', 'localName', 'namespaceURI'のみを配列で返しています。これにより、$dataプロパティはシリアライズされません。

オブジェクトがアンシリアライズ（unserialize()関数によるオブジェクトの復元）される際には、__wakeupメソッドが呼ばれます。このメソッド内で、シリアライズされなかった$dataプロパティを再初期化しています。

サンプルコードでは、DOMDocumentを作成し、MyElementのインスタンスをDOMツリーに追加しています。シリアライズ前には$dataプロパティに初期値が設定されていますが、シリアライズとアンシリアライズ後には__wakeupメソッドで再初期化された値に変化していることが確認できます。

このように、__sleepメソッドを利用することで、シリアライズ時に特定のプロパティを除外したり、必要なプロパティのみを保存したりすることが可能です。データベース接続などのリソースをシリアライズ対象から除外する場合などに有効です。