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

Copy
1<?php
2
3// SplDoublyLinkedList は、PHP標準の二重リンクリスト実装です。
4// これは、両端から要素の追加や削除ができるデータ構造を提供します。
5
6// 1. 元のSplDoublyLinkedListを作成し、いくつかの要素を追加します。
7$originalList = new SplDoublyLinkedList();
8$originalList->push('Apple');    // リストの末尾に要素を追加
9$originalList->push('Banana');
10$originalList->unshift('Cherry'); // リストの先頭に要素を追加
11
12echo "--- 元のリストの内容 ---" . PHP_EOL;
13foreach ($originalList as $item) {
14    echo "- " . $item . PHP_EOL;
15}
16echo "元のリストの要素数: " . $originalList->count() . PHP_EOL . PHP_EOL;
17
18// 2. SplDoublyLinkedListオブジェクトをシリアライズ（文字列に変換）します。
19// これにより、オブジェクトの現在の状態を保存し、後で復元できるようになります。
20$serializedList = serialize($originalList);
21
22echo "--- シリアライズされた文字列 ---" . PHP_EOL;
23echo $serializedList . PHP_EOL . PHP_EOL;
24
25// 3. シリアライズされた文字列をデシリアライズ（オブジェクトに復元）します。
26// このプロセス中に、SplDoublyLinkedListクラスの内部的な __unserialize メソッドが
27// PHPエンジンによって自動的に呼び出され、オブジェクトの状態が復元されます。
28$unserializedList = unserialize($serializedList);
29
30echo "--- デシリアライズされたリストの内容 ---" . PHP_EOL;
31// 復元されたリストがSplDoublyLinkedListのインスタンスであることを確認し、その内容を表示します。
32if ($unserializedList instanceof SplDoublyLinkedList) {
33    foreach ($unserializedList as $item) {
34        echo "- " . $item . PHP_EOL;
35    }
36    echo "デシリアライズされたリストの要素数: " . $unserializedList->count() . PHP_EOL;
37} else {
38    echo "エラー: デシリアライズされたデータはSplDoublyLinkedListオブジェクトではありません。" . PHP_EOL;
39}
40
41?>

PHPのSplDoublyLinkedList::__unserializeメソッドは、PHP 8から導入された特別な機能です。このメソッドは、serialize()関数によって文字列化されたSplDoublyLinkedListオブジェクトを、unserialize()関数を使って元のオブジェクトの状態に復元する際に、PHPエンジンによって自動的に呼び出されます。開発者が直接このメソッドを呼び出すことは通常ありません。

SplDoublyLinkedListは、両端から要素の追加や削除ができる二重リンクリストというデータ構造を提供する標準クラスです。このオブジェクトをserialize()関数で文字列に変換すると、その時点でのリストの内容や状態が保存されます。その後、この文字列をunserialize()関数に渡すと、PHPは保存された情報をもとに新しいSplDoublyLinkedListオブジェクトを再構築します。この再構築の過程で、内部的に__unserializeメソッドが呼び出され、引数である$data配列に格納された復元に必要なデータを利用して、リストの要素や構造が正確に復元されます。このメソッドの戻り値はvoidであり、特に値を返しません。この仕組みにより、PHPのunserialize機能を通じてSplDoublyLinkedListの状態を簡単に保存し、後で完全に復元することが可能になります。

Copy
1<?php
2
3/**
4 * SplDoublyLinkedListのインスタンスをシリアライズし、アンシリアライズ後、
5 * その内容をJSON形式に変換して出力するサンプルコードです。
6 *
7 * SplDoublyLinkedList::__unserializeメソッドは、PHPのunserialize()関数が
8 * SplDoublyLinkedListオブジェクトを復元する際に内部的に呼び出されます。
9 * このメソッドは、シリアライズされたデータからオブジェクトの状態を再構築する役割を持ちます。
10 *
11 * この例では、SplDoublyLinkedListの作成、シリアライズ、アンシリアライズ、
12 * そして復元されたリストの内容をJSONに変換する一連の流れを示します。
13 */
14
15// 1. SplDoublyLinkedListのインスタンスを作成し、データを追加します。
16$originalList = new SplDoublyLinkedList();
17$originalList->push('りんご');
18$originalList->push('バナナ');
19$originalList->push('チェリー');
20$originalList->unshift('オレンジ'); // 先頭に要素を追加
21
22echo "--- 元のリストの内容 ---\n";
23foreach ($originalList as $item) {
24    echo "- " . $item . "\n";
25}
26echo "\n";
27
28// 2. SplDoublyLinkedListのインスタンスをシリアライズします。
29//    この時、PHPはオブジェクトの内部状態を文字列に変換します。
30$serializedData = serialize($originalList);
31echo "--- シリアライズされたデータ ---\n";
32echo $serializedData . "\n\n";
33
34// 3. シリアライズされたデータをアンシリアライズします。
35//    unserialize()関数が呼び出されると、PHPは内部的に
36//    SplDoublyLinkedList::__unserializeメソッドを呼び出し、
37//    シリアライズされたデータ（array $data）を基にリストの状態を復元します。
38$unserializedList = unserialize($serializedData);
39
40// 4. アンシリアライズ後のリストがSplDoublyLinkedListのインスタンスであることを確認し、
41//    その内容を配列に格納してからJSON形式に変換します。
42if ($unserializedList instanceof SplDoublyLinkedList) {
43    echo "--- アンシリアライズ後のリストの内容 ---\n";
44    $listContentAsArray = [];
45    foreach ($unserializedList as $item) {
46        echo "- " . $item . "\n";
47        $listContentAsArray[] = $item;
48    }
49    echo "\n";
50
51    // 5. リストの内容を格納した配列をJSON形式に変換します。
52    //    JSON_PRETTY_PRINTで整形し、JSON_UNESCAPED_UNICODEで日本語文字をそのまま出力します。
53    $jsonOutput = json_encode($listContentAsArray, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE);
54
55    echo "--- JSON形式に変換されたデータ ---\n";
56    echo $jsonOutput . "\n";
57} else {
58    echo "エラー: アンシリアライズに失敗しました。期待されたSplDoublyLinkedListインスタンスではありません。\n";
59}
60
61?>

このコードは、PHPのSplDoublyLinkedListという双方向リンクリストのオブジェクトを、一度文字列に変換（シリアライズ）し、その文字列から元のオブジェクトの状態に復元（アンシリアライズ）する一連の流れと、最終的にその内容をJSON形式で出力する方法を示しています。

特に重要なのは、SplDoublyLinkedList::__unserializeメソッドです。このメソッドは、PHPのunserialize()関数が、シリアライズされたデータからSplDoublyLinkedListオブジェクトを復元する際に、内部的に自動で呼び出される特別なメソッドです。引数array $dataには、復元に必要なオブジェクトの内部状態を記述した配列が渡され、このメソッドはそれを基にしてオブジェクトの状態を再構築します。戻り値はvoidであり、メソッド自体は値を返さず、対象のオブジェクトの内部状態を直接更新することで復元処理を行います。

サンプルコードでは、リストを作成して要素を追加した後、serialize()で文字列化し、さらにunserialize()で元のオブジェクトに戻しています。このunserialize()の実行時に、__unserializeメソッドが機能します。復元されたリストは、その内容を配列に格納された後、json_encode()関数によってウェブアプリケーションなどで広く利用されるJSON形式に変換され出力されています。これは、オブジェクトの永続化や、データ交換のシナリオで役立つ基本的な概念です。