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

Copy
1<?php
2
3namespace Dom;
4
5class MyNode extends \DOMNode
6{
7    private $data;
8
9    public function __construct($data)
10    {
11        // DOMNode は直接インスタンス化できないため、createElement などで作成したノードを継承して使用します。
12        // ここでは例として、適当なデータを保持するプロパティを設定します。
13        $this->data = $data;
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    public function getData(): string
32    {
33        return $this->data;
34    }
35}
36
37// DOMDocument を作成し、MyNode をappendChildします。
38$dom = new \DOMDocument();
39$myNode = new MyNode("This is my data.");
40$element = $dom->createElement("myElement");
41
42// MyNodeをDOMDocumentに追加するためにimportNodeを使用します。
43$importedNode = $dom->importNode($myNode, true);
44$element->appendChild($importedNode);
45$dom->appendChild($element);
46
47// シリアライズ
48$serialized = serialize($dom);
49
50// アンシリアライズ
51$unserialized = unserialize($serialized);
52
53// アンシリアライズされたオブジェクトからデータを取り出す
54$unserializedMyNode = $unserialized->getElementsByTagName("myElement")->item(0)->firstChild;
55
56// データが正しくシリアライズ、アンシリアライズされているか確認
57if ($unserializedMyNode instanceof MyNode) {
58    echo $unserializedMyNode->getData(); // Output: This is my data.
59}

Dom\Nodeクラスの__sleepメソッドは、オブジェクトがシリアライズされる際に自動的に呼ばれるマジックメソッドです。このメソッドを使用することで、オブジェクトの状態を保存する際にどのプロパティをシリアライズするかを制御できます。

サンプルコードでは、DOMNodeを継承したMyNodeクラスを定義しています。MyNodeクラスは、シリアライズしたいデータ（$dataプロパティ）を保持しています。

__sleepメソッドは、シリアライズ対象のプロパティ名を配列で返します。サンプルでは['data']を返すことで、$dataプロパティのみがシリアライズされます。

__wakeupメソッドは、オブジェクトがアンシリアライズされる際に自動的に呼ばれるマジックメソッドです。シリアライズされたデータからオブジェクトを復元する処理を記述します。サンプルでは特に処理を行っていません。

この例では、DOMDocumentを作成し、MyNodeオブジェクトをその一部として追加しています。serialize()関数でDOMDocumentオブジェクトをシリアライズし、unserialize()関数でアンシリアライズしています。

アンシリアライズ後、getElementsByTagName()とitem()を使ってMyNodeオブジェクトを取得し、getData()メソッドでデータを取り出しています。

この仕組みを利用することで、シリアライズ時に不要な情報を取り除き、アンシリアライズ時に必要な情報を復元するなど、オブジェクトのシリアライズ・アンシリアライズ処理をカスタマイズできます。