【PHP8.x】SplStack::__unserialize()メソッドの使い方

Copy
1<?php
2
3// このサンプルコードは、SplStack クラスがどのようにシリアライズ（オブジェクトの状態を保存）され、
4// アンシリアライズ（保存された状態からオブジェクトを復元）されるかを示します。
5//
6// SplStack::__unserialize メソッドは、unserialize() 関数によってオブジェクトが復元される際に、
7// PHP エンジンによって内部的に呼び出されるマジックメソッドです。
8// 通常、ユーザーがこのメソッドを直接呼び出すことはありませんが、
9// その存在によって SplStack オブジェクトが、保存された状態から正しく復元されます。
10
11// 1. SplStack クラスのインスタンスを作成し、要素を追加します。
12// SplStack はLIFO（Last-In, First-Out）のデータ構造です。
13$stack = new SplStack();
14$stack->push('Apple');   // 最初に追加された要素 (スタックの底)
15$stack->push('Banana');
16$stack->push('Cherry');  // 最後に追加された要素 (スタックの先頭)
17
18echo "--- 元のスタックの状態 ---" . PHP_EOL;
19echo "スタックのサイズ: " . $stack->count() . PHP_EOL;
20// foreach でのイテレートは、スタックの先頭から底へ向かって要素を取り出します。
21echo "要素（先頭から底へ）:" . PHP_EOL; 
22foreach ($stack as $item) {
23    echo "- " . $item . PHP_EOL;
24}
25echo "スタックの底の要素: " . $stack->bottom() . PHP_EOL; // "Apple"
26echo "スタックの先頭の要素: " . $stack->top() . PHP_EOL;    // "Cherry"
27echo PHP_EOL;
28
29// 2. SplStack オブジェクトをシリアライズします。
30// serialize() 関数はオブジェクトの状態を文字列に変換します。
31// これにより、オブジェクトをファイルに保存したり、ネットワーク経由で送信したりできるようになります。
32$serializedStack = serialize($stack);
33
34echo "--- シリアライズされたスタック (文字列形式) ---" . PHP_EOL;
35echo $serializedStack . PHP_EOL;
36echo PHP_EOL;
37
38// 3. シリアライズされた文字列をデシリアライズして、元のオブジェクトに復元します。
39// unserialize() 関数は文字列からオブジェクトの状態を復元します。
40// この際、PHPエンジンは復元されるクラス（この場合は SplStack）の内部的な
41// __unserialize ロジック（またはそれに相当する処理）を自動的に呼び出し、
42// スタックの要素や状態を正しく再構築します。
43$unserializedStack = unserialize($serializedStack);
44
45echo "--- デシリアライズされたスタックの状態 ---" . PHP_EOL;
46if ($unserializedStack instanceof SplStack) {
47    echo "デシリアライズが成功しました。復元されたオブジェクトは SplStack のインスタンスです。" . PHP_EOL;
48    echo "スタックのサイズ: " . $unserializedStack->count() . PHP_EOL;
49    echo "要素（先頭から底へ）:" . PHP_EOL;
50    foreach ($unserializedStack as $item) {
51        echo "- " . $item . PHP_EOL;
52    }
53    echo "スタックの底の要素: " . $unserializedStack->bottom() . PHP_EOL; // "Apple"
54    echo "スタックの先頭の要素: " . $unserializedStack->top() . PHP_EOL;    // "Cherry"
55} else {
56    echo "デシリアライズに失敗しました。期待される SplStack のインスタンスではありません。" . PHP_EOL;
57    var_dump($unserializedStack);
58}
59
60// 復元されたスタックが元のスタックと内容的に同じであることを確認します。
61echo PHP_EOL;
62echo "--- 検証 ---" . PHP_EOL;
63if ($stack->count() === $unserializedStack->count() &&
64    $stack->bottom() === $unserializedStack->bottom() &&
65    $stack->top() === $unserializedStack->top()) {
66    echo "元のスタックとデシリアライズされたスタックは正しく一致します。" . PHP_EOL;
67} else {
68    echo "元のスタックとデシリアライズされたスタックは一致しませんでした。" . PHP_EOL;
69}
70
71?>

SplStack::__unserializeは、PHPのunserialize()関数によってオブジェクトが復元される際に、PHPエンジンが内部的に自動で呼び出す特殊なメソッドです。このメソッドは、SplStackオブジェクトが以前にserialize()関数で文字列化された状態から、元のオブジェクトの状態を正確に再構築するために利用されます。通常、このマジックメソッドを開発者が直接呼び出すことはありません。

サンプルコードでは、まずSplStackのインスタンスを作成し、複数の要素を追加しています。次に、serialize()関数を使用してこのオブジェクトを文字列形式に変換しています。この文字列は、オブジェクトの内部状態を保存するためのデータです。その後、unserialize()関数を用いてこの文字列から新しいSplStackオブジェクトを復元しています。この復元処理において、PHPエンジンはSplStack::__unserializeメソッドを内部的に実行し、シリアライズされたデータ（引数$dataとして内部的に渡される配列）に基づいてスタックの要素や順序を正しく再構築します。

このメソッドは引数として、シリアライズされたオブジェクトのデータを格納する配列 $data を受け取りますが、これはunserialize()関数によって自動的に供給されるものです。また、オブジェクトの復元処理がメソッドの内部で完結するため、このメソッドは特に戻り値を返しません。このようにして、SplStackオブジェクトは保存と復元のプロセスを経て、その状態が正確に維持されます。

Copy
1<?php
2
3/**
4 * SplStackを継承し、カスタムのシリアライズ・デシリアライズ機能を持つスタッククラス。
5 * PHPのunserialize()関数によってオブジェクトが復元される際に、
6 * SplStack::__unserialize (このクラスではオーバーライド) がどのように機能するかを示します。
7 */
8class MySerializableStack extends SplStack
9{
10    private string $name;
11
12    public function __construct(string $name = 'Default Stack')
13    {
14        parent::__construct();
15        $this->name = $name;
16    }
17
18    public function getName(): string
19    {
20        return $this->name;
21    }
22
23    /**
24     * オブジェクトがシリアライズされる際に呼び出されます。
25     * オブジェクトの状態を表すデータを配列として返します。
26     *
27     * @return array シリアライズすべきデータ
28     */
29    public function __serialize(): array
30    {
31        // SplStackの要素を、イテレータの順序（スタックのトップからボトムへ）で配列に格納します。
32        $elements = iterator_to_array($this);
33
34        // スタックの要素と追加のプロパティをシリアライズデータとして返します。
35        return [
36            'name' => $this->name,
37            'elements' => $elements,
38        ];
39    }
40
41    /**
42     * オブジェクトがデシリアライズされる際に呼び出されます。
43     * __serialize()によって返されたデータ配列を受け取り、オブジェクトの状態を復元します。
44     *
45     * @param array $data __serialize()から提供されたデータ
46     * @return void
47     */
48    public function __unserialize(array $data): void
49    {
50        // 渡されたデータからプロパティを復元します。
51        $this->name = $data['name'] ?? 'Restored Stack';
52
53        // スタックの要素を復元します。
54        // __serialize()で要素はトップからボトムの順で格納されています。
55        // SplStackに元のプッシュ順序（ボトムからトップ）で要素を再プッシュするためには、
56        // 格納された配列を逆順にしてからプッシュする必要があります。
57        if (isset($data['elements']) && is_array($data['elements'])) {
58            $elementsToPush = array_reverse($data['elements']);
59            foreach ($elementsToPush as $element) {
60                $this->push($element);
61            }
62        }
63    }
64}
65
66// --- サンプルコードの実行 ---
67
68// 1. オリジナルのスタックを作成し、要素を追加します。
69echo "--- Original Stack ---\n";
70$originalStack = new MySerializableStack('User Tasks');
71$originalStack->push('Task A');
72$originalStack->push('Task B');
73$originalStack->push('Task C'); // 最も新しい要素 (スタックのトップ)
74
75echo "Stack Name: " . $originalStack->getName() . "\n";
76echo "Elements (top to bottom):\n";
77foreach ($originalStack as $item) {
78    echo "- " . $item . "\n";
79}
80echo "Count: " . $originalStack->count() . "\n\n";
81
82
83// 2. スタックオブジェクトをシリアライズします。
84// この過程で MySerializableStack::__serialize() が呼び出されます。
85$serializedData = serialize($originalStack);
86echo "--- Serialized Data ---\n";
87echo $serializedData . "\n\n";
88
89// 3. シリアライズされたデータをデシリアライズして、新しいオブジェクトを作成します。
90// この過程で MySerializableStack::__unserialize($data) が内部的に呼び出されます。
91echo "--- Deserialized Stack ---\n";
92$deserializedStack = unserialize($serializedData);
93
94if ($deserializedStack instanceof MySerializableStack) {
95    echo "Stack Name: " . $deserializedStack->getName() . "\n";
96    echo "Elements (top to bottom):\n";
97    foreach ($deserializedStack as $item) {
98        echo "- " . $item . "\n";
99    }
100    echo "Count: " . $deserializedStack->count() . "\n\n";
101
102    // 4. デシリアライズされたスタックの内容をJSON形式に変換します。
103    // これはキーワード「php unserialize to json online」に関連する処理です。
104    echo "--- Deserialized Stack to JSON ---\n";
105    $jsonOutput = json_encode([
106        'name' => $deserializedStack->getName(),
107        // SplStackのイテレータはトップからボトムへ要素を返すため、
108        // その順序でJSON配列に変換します。
109        'elements' => iterator_to_array($deserializedStack),
110        'count' => $deserializedStack->count(),
111    ], JSON_PRETTY_PRINT);
112    echo $jsonOutput . "\n";
113
114} else {
115    echo "Error: Deserialization failed or returned an unexpected type.\n";
116}
117
118?>

__unserializeメソッドは、PHPのunserialize()関数を用いてオブジェクトを復元する際に、自動的に呼び出される特殊なメソッドです。このメソッドは、オブジェクトの内部状態をデータとして保存する__serialize()メソッドと対になり、保存されたデータからオブジェクトを元の状態に再構築する役割を担います。

引数array $dataは、__serialize()メソッドがオブジェクトの状態を表すために返した配列データを受け取ります。この配列には、オブジェクトの各プロパティの値や、含まれている要素などが格納されています。__unserializeメソッドは、この$data配列から情報を読み取り、その情報に基づいて自身のオブジェクトのプロパティを適切に設定したり、今回のSplStackのように内部のコレクションに要素を正しい順序で再追加したりして、オブジェクトの状態を復元します。戻り値はvoidであり、このメソッドは値を返さず、引数で受け取ったデータを用いて自身のオブジェクトの状態を直接変更することで復元処理を完了させます。

提供されたMySerializableStackクラスの例では、__unserializeメソッドが$dataからスタック名と要素の配列を取り出し、SplStackの特性を考慮して要素を逆順でプッシュし直すことで、シリアライズ前のスタックの状態を正確に再現しています。このように復元されたオブジェクトは、unserialize後にその情報をjson_encodeでJSON形式に変換するなど、元のオブジェクトと同様に活用できます。