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

Copy
1<?php
2
3/**
4 * DOMAttr オブジェクトの属性名と値をカプセル化し、シリアライズ動作を制御するクラスです。
5 *
6 * DOMAttr クラスは組み込みクラスであり、直接 __sleep メソッドを実装することはできません。
7 * このサンプルでは、DOMAttr に関連するデータを保持するユーザー定義クラスを通して、
8 * __sleep マジックメソッドの動作をシステムエンジニアを目指す初心者向けに示します。
9 *
10 * __sleep メソッドは、オブジェクトが serialize() される際に、どのプロパティを
11 * シリアライズ対象とするかを指定するために使用されます。
12 * キーワードにある「sleep 0.5 秒」のようにプログラムの実行を一時停止させる
13 * `sleep()` 関数とは機能が異なりますのでご注意ください。
14 */
15class AttributeData
16{
17    /** @var string 属性名 */
18    public string $name;
19
20    /** @var string 属性値 */
21    public string $value;
22
23    /** @var string|null DOMAttr には直接関係ない追加プロパティの例 */
24    public ?string $description = null;
25
26    /**
27     * コンストラクタ
28     *
29     * @param string $name        属性名
30     * @param string $value       属性値
31     * @param string|null $description 説明（シリアライズ対象外の例）
32     */
33    public function __construct(string $name, string $value, ?string $description = null)
34    {
35        $this->name = $name;
36        $this->value = $value;
37        $this->description = $description;
38    }
39
40    /**
41     * オブジェクトが serialize() される直前に自動的に呼び出されるマジックメソッドです。
42     *
43     * このメソッドは、シリアライズすべきプロパティ名の配列を返します。
44     * ここで返されないプロパティは、シリアライズされません。
45     *
46     * リファレンス情報にある「DOMAttr::__sleep」を参考に、
47     * 属性の主要な情報である 'name' と 'value' のみをシリアライズ対象としています。
48     *
49     * @return array シリアライズするプロパティ名の配列
50     */
51    public function __sleep(): array
52    {
53        // 'name' と 'value' プロパティのみをシリアライズ対象とする
54        // 'description' プロパティはシリアライズ対象から除外されるため、
55        // デシリアライズ後には初期値（null）に戻ります。
56        return ['name', 'value'];
57    }
58
59    /**
60     * オブジェクトが unserialize() された直後に自動的に呼び出されるマジックメソッドです。
61     *
62     * 必要に応じて、デシリアライズ後のオブジェクトの再初期化処理をここで行うことができます。
63     */
64    public function __wakeup(): void
65    {
66        // 例: デシリアライズ後にログ出力を行う
67        echo "[__wakeup] AttributeData オブジェクトがデシリアライズされました。\n";
68    }
69
70    /**
71     * オブジェクトを文字列として扱う際の表現を定義します。
72     *
73     * @return string
74     */
75    public function __toString(): string
76    {
77        $desc = $this->description ? " (Description: {$this->description})" : "";
78        return "Attribute: {$this->name}=\"{$this->value}\"{$desc}";
79    }
80}
81
82// --- サンプルコードの実行 ---
83
84// 1. AttributeData オブジェクトの作成
85echo "--- オブジェクト作成とシリアライズ前の状態 ---" . PHP_EOL;
86$originalAttr = new AttributeData('id', 'item-123', 'ユニークな識別子');
87echo "元のオブジェクト: " . $originalAttr . PHP_EOL;
88echo "元のオブジェクトの description: " . ($originalAttr->description ?? 'N/A') . PHP_EOL;
89echo PHP_EOL;
90
91// 2. オブジェクトのシリアライズ
92// __sleep メソッドが呼び出され、'name' と 'value' プロパティのみがシリアライズ対象となる
93echo "--- シリアライズ処理 ---" . PHP_EOL;
94$serializedData = serialize($originalAttr);
95echo "シリアライズされたデータ: " . $serializedData . PHP_EOL;
96echo PHP_EOL;
97
98// 3. シリアライズされたデータのデシリアライズ
99// __wakeup メソッドが呼び出され、オブジェクトが再構築される
100echo "--- デシリアライズ処理 ---" . PHP_EOL;
101$unserializedAttr = unserialize($serializedData);
102echo "デシリアライズされたオブジェクト: " . $unserializedAttr . PHP_EOL;
103echo "デシリアライズされたオブジェクトの description: " . ($unserializedAttr->description ?? 'N/A') . PHP_EOL;
104echo PHP_EOL;
105
106// 4. シリアライズ・デシリアライズの結果確認
107echo "--- 結果の検証 ---" . PHP_EOL;
108if ($unserializedAttr instanceof AttributeData) {
109    echo "✔ オブジェクトは AttributeData のインスタンスです。" . PHP_EOL;
110    echo "✔ name: " . ($unserializedAttr->name === $originalAttr->name ? '一致' : '不一致') . PHP_EOL;
111    echo "✔ value: " . ($unserializedAttr->value === $originalAttr->value ? '一致' : '不一致') . PHP_EOL;
112    echo "✔ description: " . (is_null($unserializedAttr->description) ? '除外され、初期値に戻った' : 'エラー') . PHP_EOL;
113    echo "   (description プロパティは __sleep で除外されたため null になります)" . PHP_EOL;
114} else {
115    echo "✘ デシリアライズに失敗しました。" . PHP_EOL;
116}

PHPの__sleepメソッドは、オブジェクトをファイルなどに保存するため文字列に変換する「シリアライズ」処理を制御するマジックメソッドです。このメソッドは、serialize()関数が呼び出される直前に自動的に実行されます。引数はなく、戻り値としてシリアライズ対象としたいプロパティ名を文字列で含む配列を返します。この配列に指定されたプロパティだけが保存対象となり、それ以外のプロパティはシリアライズ時に除外されます。

サンプルコードでは、AttributeDataクラスが持つname、value、そして追加情報であるdescriptionというプロパティのうち、__sleepメソッドによってnameとvalueのみをシリアライズ対象として指定しています。そのため、元のオブジェクトにあったdescriptionプロパティはシリアライズされず、unserialize()関数でオブジェクトを復元した際には初期値のnullに戻る結果となります。この機能は、オブジェクトから必要な情報だけを選んで効率的に保存したり、外部に公開したくないプロティを除外したりする際に便利です。

なお、キーワードにある「php sleep 0.5 秒」のようにプログラムの実行を一時停止させるPHPのsleep()関数とは、機能が全く異なりますので混同しないようご注意ください。

Copy
1<?php
2
3/**
4 * DOMAttrオブジェクトのシリアライズ動作をデモンストレーションします。
5 * DOMAttr::__sleepは、オブジェクトがserialize()関数によってシリアライズされる際に、
6 * PHPの内部で呼び出され、どのプロパティを保存するかを決定するマジックメソッドです。
7 * 開発者が直接このメソッドを定義することはできませんが、その動作結果を確認できます。
8 *
9 * この例では、DOMAttrオブジェクトをシリアライズし、その結果から__sleepメソッドが
10 * どのように動作しているかを推測します。
11 */
12function demonstrateDOMAttrSerialization(): void
13{
14    // 1. DOMDocumentとDOMAttrオブジェクトの作成
15    $dom = new DOMDocument('1.0', 'UTF-8');
16    $element = $dom->createElement('item');
17    $attribute = $dom->createAttribute('data-id');
18    $attribute->value = 'unique-123';
19    $element->setAttributeNode($attribute);
20    $dom->appendChild($element);
21
22    echo "--- DOMAttr::__sleep のデモンストレーション ---" . PHP_EOL;
23
24    echo "元の DOMAttr オブジェクト:" . PHP_EOL;
25    var_dump($attribute);
26
27    // 2. DOMAttrオブジェクトをシリアライズします。
28    // この操作の際、DOMAttrクラスの内部的な__sleepメソッドが呼び出され、
29    // シリアライズされるプロパティが決定されます。
30    // PHPの内部クラスであるDOMAttrは、カスタムシリアライゼーション (C:) を使用し、
31    // 通常、オブジェクトのプロパティを直接保存する形ではないことが多いです。
32    $serializedAttribute = serialize($attribute);
33    echo PHP_EOL . "シリアライズされた DOMAttr オブジェクトの文字列:" . PHP_EOL;
34    echo $serializedAttribute . PHP_EOL;
35    // 出力例: C:8:"DOMAttr":13:{a:0:{}}
36    // 'C' はカスタムシリアライゼーションを意味し、PHPがDOMAttrのシリアライズを
37    // 特別な方法で処理していることを示します。
38    // '{a:0:{}}' は、このカスタムシリアライゼーションにおいて、標準のプロパティが
39    // 配列として保存されていないことを示唆しています。これは、DOMAttr::__sleepが
40    // 空の配列を返すか、またはカスタムロジックが別の方法で情報を処理するためです。
41
42    // 3. シリアライズされたデータをアンシリアライズしようとします。
43    // DOMAttrオブジェクトはDOMツリーのコンテキストで機能するため、
44    // 単独でアンシリアライズしても元の機能的な状態を完全に復元することはできません。
45    // そのため、通常は意味のあるオブジェクトは復元されず、警告が発生する可能性があります。
46    $unserializedAttribute = @unserialize($serializedAttribute); // エラーが出ないように@で抑制
47    echo PHP_EOL . "アンシリアライズされたオブジェクト:" . PHP_EOL;
48    var_dump($unserializedAttribute);
49}
50
51// デモンストレーション関数を実行
52demonstrateDOMAttrSerialization();
53

PHP 8のDOMAttr::__sleepメソッドは、DOMAttrオブジェクトをserialize()関数でシリアライズする際に、PHP内部で自動的に呼び出される特別なマジックメソッドです。このメソッドは、オブジェクトのどのプロパティをシリアライズ対象とするかを決定しますが、開発者が直接定義したり呼び出したりすることはありません。

引数は不要で、通常はシリアライズするプロパティ名の文字列配列を返します。しかし、DOMAttrのようなPHPの内部クラスは、カスタムシリアライゼーション（C:プレフィックス）を用いることが多く、__sleepメソッドが空の配列を返すか、独自の内部ロジックでシリアライズ処理を行います。そのため、サンプルコードのようにDOMAttrオブジェクトをserialize()すると、「C:8:"DOMAttr":13:{a:0:{}}」といった形式で出力され、標準のプロパティが直接保存されていないことが示されます。これは、DOMAttrがDOMツリーのコンテキストで機能するため、単独でのシリアライズ・アンシリアライズでは元の完全な機能状態を復元することが難しいという特性によるものです。このメソッドの動作を理解することは、PHPオブジェクトのシリアライゼーションにおける内部的な挙動を学ぶ上で役立ちます。