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

Copy
1<?php
2
3// ArrayObject を使用して連想配列をオブジェクトとして扱います。
4// これは配列と同じようにデータを保持しつつ、オブジェクト指向的な操作が可能です。
5$initialData = [
6    'product_id' => 101,
7    'product_name' => 'Example Widget',
8    'price' => 29.99,
9    'in_stock' => true,
10];
11$arrayObject = new ArrayObject($initialData);
12
13echo "--- 元の ArrayObject の内容 ---\n";
14var_dump($arrayObject->getArrayCopy());
15
16// ArrayObject をシリアライズします。
17// `serialize()` 関数が呼び出されると、PHPの内部で ArrayObject::__serialize() メソッドが使用され、
18// オブジェクトの状態がバイナリ形式の文字列に変換されます。
19// このメソッドは、PHP 7.4以降の新しいシリアライズメカニズムの一部です。
20$serializedData = serialize($arrayObject);
21
22echo "\n--- シリアライズされたデータ ---\n";
23var_dump($serializedData);
24
25// シリアライズされたデータを逆シリアライズして ArrayObject を復元します。
26// `unserialize()` 関数が呼び出されると、PHPの内部で `ArrayObject::__unserialize()` メソッドが自動的に呼び出されます。
27//
28// `ArrayObject::__unserialize(array $data)` メソッドは、引数 `$data` として
29// シリアライズされたデータがPHPによってデコードされた配列を受け取ります。
30// このメソッドは、受け取った `$data` を元にオブジェクトの内部状態（この場合は配列データ）を復元する役割を担います。
31// 戻り値は `void` であり、オブジェクト自身を直接変更します。
32$unserializedArrayObject = unserialize($serializedData);
33
34echo "\n--- 逆シリアライズされた ArrayObject の内容 ---\n";
35var_dump($unserializedArrayObject->getArrayCopy());
36
37// 元のオブジェクトと復元されたオブジェクトの内容が同じであることを確認します。
38if ($unserializedArrayObject instanceof ArrayObject && $unserializedArrayObject->getArrayCopy() === $arrayObject->getArrayCopy()) {
39    echo "\nArrayObject は正常にシリアライズ・逆シリアライズされました。\n";
40} else {
41    echo "\nArrayObject のシリアライズ・逆シリアライズに失敗しました。\n";
42}
43

PHPのArrayObjectは、連想配列をオブジェクトとして扱い、配列操作とオブジェクト指向的な操作の両方を可能にするクラスです。このサンプルコードでは、まず初期データをArrayObjectに格納し、その内容を表示しています。

次に、serialize()関数を用いてこのArrayObjectをバイナリ形式の文字列に変換します。この変換処理では、PHP内部でArrayObject::__serialize()メソッドが自動的に実行され、オブジェクトの状態がシリアライズ（データ変換）されます。

そして、シリアライズされた文字列をunserialize()関数で元のArrayObjectに復元します。この復元処理の際に、ArrayObject::__unserialize()メソッドがPHPによって自動的に呼び出されます。このメソッドは、引数$dataとして、シリアライズされたデータがデコードされた配列を受け取ります。__unserialize()の役割は、この$dataを利用してArrayObjectの内部状態、つまり保持している配列データを再構築することです。戻り値はvoid（何も返しません）であり、オブジェクト自身を直接変更することで状態を復元します。

最終的に、逆シリアライズによって復元されたArrayObjectの内容が、元のArrayObjectと完全に一致することが確認され、オブジェクトの状態が正確に保存・復元されるプロセスが示されています。

Copy
1<?php
2
3/**
4 * シリアライズされたArrayObjectデータをアンシリアライズし、JSON文字列に変換します。
5 *
6 * この関数は、シリアライズされたPHPのオブジェクト文字列を受け取り、
7 * それをArrayObjectとして復元し、最終的にJSON形式の文字列に変換します。
8 * ArrayObject::__unserialize メソッドは、unserialize() 関数がオブジェクトを復元する際に
9 * 内部的に呼び出され、オブジェクトの状態を再構築するために使用されます。
10 *
11 * @param string $serializedData シリアライズされたデータ文字列。
12 * @return string|false JSON文字列、またはアンシリアライズや変換に失敗した場合はfalse。
13 */
14function unserializeArrayObjectToJson(string $serializedData): string|false
15{
16    // シリアライズされたデータをアンシリアライズします。
17    // この処理中にArrayObject::__unserialize メソッドが内部的に呼び出され、
18    // オブジェクトのプロパティが元の状態に復元されます。
19    $unserializedObject = unserialize($serializedData);
20
21    // 復元されたデータがArrayObjectのインスタンスであるかを確認します。
22    // 期待する型でない場合や復元に失敗した場合はエラーとして扱います。
23    if (!($unserializedObject instanceof ArrayObject)) {
24        // エラーログに出力し、falseを返します。
25        error_log('アンシリアライズに失敗しました。データがArrayObjectではありません。');
26        return false;
27    }
28
29    // アンシリアライズされたArrayObjectをJSON文字列に変換します。
30    // ArrayObjectはTraversableインターフェースを実装しているため、
31    // json_encode() 関数で直接配列のように扱うことができます。
32    // JSON_PRETTY_PRINT は、読みやすいように整形されたJSONを生成するためのオプションです。
33    $jsonString = json_encode($unserializedObject, JSON_PRETTY_PRINT);
34
35    // JSON変換に失敗した場合もエラーとして扱います。
36    if ($jsonString === false) {
37        error_log('JSON変換に失敗しました。');
38        return false;
39    }
40
41    return $jsonString;
42}
43
44// --- サンプルコードの実行 ---
45
46// 1. ArrayObjectのインスタンスを作成し、初期データを設定します。
47$originalArrayObject = new ArrayObject([
48    'productId' => 101,
49    'productName' => 'Sample Widget',
50    'price' => 29.99,
51    'inStock' => true,
52    'tags' => ['electronics', 'gadget']
53]);
54
55echo "--- 元のArrayObjectの内容 ---\n";
56print_r($originalArrayObject);
57echo "\n";
58
59// 2. ArrayObjectをシリアライズし、文字列形式で保存します。
60// これにより、オブジェクトの状態が永続化可能な形式になります。
61$serializedArrayObject = serialize($originalArrayObject);
62
63echo "--- シリアライズされたデータ ---\n";
64echo $serializedArrayObject . "\n\n";
65
66// 3. シリアライズされたデータをアンシリアライズし、JSONに変換します。
67$jsonOutput = unserializeArrayObjectToJson($serializedArrayObject);
68
69if ($jsonOutput !== false) {
70    echo "--- アンシリアライズ後にJSONに変換されたデータ ---\n";
71    echo $jsonOutput . "\n";
72} else {
73    echo "エラー: データの変換に失敗しました。\n";
74}
75
76?>

このPHPサンプルコードは、ArrayObjectという、配列のように扱える特別なオブジェクトのデータを、シリアライズ（オブジェクトを文字列形式に変換）された状態から、元のオブジェクトに復元し、最終的にJSON形式の文字列に変換する一連の流れを示しています。

重要なのは、unserialize()関数がシリアライズされたデータをオブジェクトに復元する際に、内部的にArrayObject::__unserializeメソッドを呼び出す点です。この__unserializeメソッドは、シリアライズデータから抽出されたオブジェクトのプロパティ情報を含む配列 $data を引数として受け取ります。そして、その $data をもとに自身のインスタンスの内部状態を再構築します。このメソッド自体はオブジェクトの状態を直接変更するため、明示的な戻り値はありません。

サンプルコードでは、まずArrayObjectをserialize()関数で文字列化します。次に、unserializeArrayObjectToJson()関数内でこの文字列をunserialize()することで、ArrayObjectが復元され、その際に__unserializeが実行されます。復元されたArrayObjectは、配列のように反復可能な特性（Traversableインターフェースを実装）を持つため、json_encode()関数によって簡単にJSON文字列に変換できます。このように、シリアライズとアンシリアライズは、PHPオブジェクトの永続化やデータ転送に用いられる基本的な手法です。