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

Copy
1<?php
2
3class MyDocumentType extends DOMDocumentType {
4    private $name;
5    private $publicId;
6    private $systemId;
7
8    public function __construct(string $qualifiedName, string $publicId = '', string $systemId = '') {
9        $this->name = $qualifiedName;
10        $this->publicId = $publicId;
11        $this->systemId = $systemId;
12        parent::__construct($qualifiedName, $publicId, $systemId);
13    }
14
15    public function getName(): string {
16        return $this->name;
17    }
18
19    public function getPublicId(): string {
20        return $this->publicId;
21    }
22
23    public function getSystemId(): string {
24        return $this->systemId;
25    }
26
27    /**
28     * serialize 時に保存するプロパティを定義する
29     *
30     * @return array
31     */
32    public function __sleep(): array {
33        return ['name', 'publicId', 'systemId'];
34    }
35
36    /**
37     * unserialize 時にプロパティを復元する処理 (省略可能)
38     *
39     * @return void
40     */
41    public function __wakeup(): void {
42        // 必要に応じて初期化処理を記述
43    }
44}
45
46// 使用例
47$doctype = new MyDocumentType('html', '-//W3C//DTD HTML 4.01 Transitional//EN', 'http://www.w3.org/TR/html4/loose.dtd');
48
49// シリアライズ
50$serialized = serialize($doctype);
51
52// アンシリアライズ
53$unserialized = unserialize($serialized);
54
55// 確認
56echo "Name: " . $unserialized->getName() . "\n";
57echo "Public ID: " . $unserialized->getPublicId() . "\n";
58echo "System ID: " . $unserialized->getSystemId() . "\n";
59?>

PHP 8のDOMDocumentTypeクラスにおける__sleepメソッドは、オブジェクトをシリアライズ（文字列に変換）する際に、どのプロパティを保存するかを定義するために使用されます。このサンプルコードでは、DOMDocumentTypeを継承したMyDocumentTypeクラスを定義し、__sleepメソッドを実装しています。

MyDocumentTypeクラスは、コンストラクタでドキュメントのname、publicId、systemIdを初期化します。これらのプロパティはprivateで定義されており、それぞれに対応するgetterメソッド(getName(), getPublicId(), getSystemId())を通じて外部からアクセスできます。

__sleepメソッドは引数を取りません。このメソッドは、シリアライズするプロパティ名を配列で返します。この例では、['name', 'publicId', 'systemId']を返すことで、これらのプロパティがシリアライズ時に保存されるように指定しています。

一方、__wakeupメソッドは、アンシリアライズ（文字列からオブジェクトを復元）する際に呼び出されます。ここではコメントアウトされていますが、必要に応じてオブジェクトの初期化処理などを記述できます。

サンプルコードの後半では、MyDocumentTypeクラスのインスタンスを作成し、serialize()関数でシリアライズ、unserialize()関数でアンシリアライズしています。そして、アンシリアライズされたオブジェクトの各プロパティを表示することで、__sleepメソッドで指定されたプロパティが正しく保存・復元されていることを確認できます。__sleepを定義することで、シリアライズされるデータ量を調整したり、特定のプロパティをシリアライズから除外したりできます。