Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

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

unserializeメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

unserializeメソッドは、シリアライズされた文字列からArrayObjectオブジェクトを復元するために実行されるメソッドです。シリアライズとは、オブジェクトの状態を、ファイルへの保存やネットワーク経由での転送が可能な文字列形式に変換する処理のことです。このunserializeメソッドは、その逆の処理、つまりシリアライズされた文字列から元のArrayObjectオブジェクトを再構築する役割を担います。このメソッドは、通常、開発者が直接呼び出すものではなく、PHPの組み込み関数であるunserialize()関数にArrayObjectをシリアライズした文字列を渡した際に、PHPの内部機構によって自動的に呼び出されます。呼び出されると、渡された文字列データに含まれる情報をもとに、ArrayObjectが内部で保持している配列の要素や、オブジェクトの振る舞いを制御するためのフラグ設定などを正確に復元します。これにより、シリアライズされる前と完全に同じ状態のオブジェクトを再現することが可能になります。このメソッドはSerializableインターフェースの要件を満たすために実装されており、オブジェクトの復元プロセスをカスタマイズするために不可欠な機能です。

構文(syntax)

1<?php
2
3// 元のデータを持つArrayObjectインスタンスを作成
4$sourceObject = new ArrayObject(['user_id' => 101, 'username' => 'guest']);
5
6// serialize()関数でオブジェクトを文字列に変換
7$serializedString = serialize($sourceObject);
8
9// unserialize()関数で文字列からオブジェクトを復元
10// この処理の内部でArrayObject::unserialize()メソッドが呼び出されます
11$restoredObject = unserialize($serializedString);
12
13var_dump($restoredObject);
14
15?>

引数(parameters)

string $data

  • string $data: オブジェクトにデシリアライズする、シリアライズされた文字列

戻り値(return)

戻り値なし

戻り値はありません

サンプルコード

PHP ArrayObject unserialize エラー処理

1<?php
2
3/**
4 * ArrayObject のデシリアライズにおけるエラー処理のサンプルコード
5 *
6 * システムエンジニアを目指す初心者向けに、PHP の unserialize() 関数が ArrayObject を
7 * デシリアライズする際に発生しうるエラー(不正なデータなど)への対処法を簡潔に示します。
8 * unserialize() 関数は、不正な入力に対して false を返し、警告 (E_WARNING) を発行する場合があります。
9 */
10function demonstrateArrayObjectUnserializeErrorHandling(): void
11{
12    // 1. 正常な ArrayObject のシリアライズとデシリアライズ
13    $originalArrayObject = new ArrayObject(['name' => 'Alice', 'age' => 30]);
14    echo "元の ArrayObject:\n";
15    print_r($originalArrayObject);
16
17    // ArrayObject をシリアライズして文字列に変換
18    $serializedData = serialize($originalArrayObject);
19    echo "シリアライズされたデータ:\n";
20    echo $serializedData . "\n\n";
21
22    // 正常なシリアライズデータから ArrayObject をデシリアライズ
23    // unserialize() は成功すれば元のオブジェクトを、失敗すれば false を返します。
24    /** @var ArrayObject|false $deserializedArrayObject */
25    $deserializedArrayObject = unserialize($serializedData);
26
27    if ($deserializedArrayObject instanceof ArrayObject) {
28        echo "正常にデシリアライズされた ArrayObject:\n";
29        print_r($deserializedArrayObject);
30    } else {
31        echo "エラー: 正常なデータのデシリアライズに失敗しました。\n"; // このパスは通常通らない
32    }
33    echo "----------------------------------------\n\n";
34
35    // 2. 不正なデータによるデシリアライズ失敗の処理
36    // シリアライズデータを意図的に破損させます(例: データを途中で切断)
37    $malformedSerializedData = substr($serializedData, 0, strlen($serializedData) - 10);
38    echo "不正なシリアライズデータ:\n";
39    echo $malformedSerializedData . "\n\n";
40
41    // 不正なデータでデシリアライズを試みる
42    // PHPはここで E_WARNING を発行する可能性がありますが、unserialize() は false を返します。
43    echo "不正なデータでデシリアライズを試みます (警告が表示される可能性があります)。\n";
44    /** @var ArrayObject|false $errorDeserializedArrayObject */
45    $errorDeserializedArrayObject = unserialize($malformedSerializedData);
46
47    if ($errorDeserializedArrayObject === false) {
48        echo "結果: 不正なデータのデシリアライズに失敗し、false が返されました。\n";
49        echo "  (データが破損していることを示唆しています)\n";
50    } elseif ($errorDeserializedArrayObject instanceof ArrayObject) {
51        echo "エラー: 不正なデータが意図せずデシリアライズされてしまいました。\n";
52        print_r($errorDeserializedArrayObject);
53    } else {
54        echo "予期せぬ結果: " . var_export($errorDeserializedArrayObject, true) . "\n";
55    }
56    echo "----------------------------------------\n\n";
57
58    // 3. 全く異なるフォーマットのデータでのデシリアライズ
59    $totallyInvalidData = 'This is just a plain string and not serialized data.';
60    echo "全く異なるフォーマットのデータ:\n";
61    echo $totallyInvalidData . "\n\n";
62
63    // 不正なフォーマットのデータでデシリアライズを試みる
64    // PHPはここで E_WARNING を発行する可能性がありますが、unserialize() は false を返します。
65    echo "全く異なるフォーマットのデータでデシリアライズを試みます (警告が表示される可能性があります)。\n";
66    /** @var ArrayObject|false $invalidFormatResult */
67    $invalidFormatResult = unserialize($totallyInvalidData);
68
69    if ($invalidFormatResult === false) {
70        echo "結果: 不正なフォーマットのデータのデシリアライズに失敗し、false が返されました。\n";
71    } else {
72        echo "エラー: 不正なフォーマットのデータがデシリアライズされてしまいました。\n";
73        print_r($invalidFormatResult);
74    }
75    echo "----------------------------------------\n";
76}
77
78// 関数の実行
79demonstrateArrayObjectUnserializeErrorHandling();
80
81?>

このサンプルコードは、PHPのunserialize()関数でArrayObjectをデシリアライズする際のエラー処理を、システムエンジニアを目指す初心者向けに解説します。unserialize()関数は、引数$dataとしてシリアライズされた文字列を受け取り、元のオブジェクト(ここではArrayObject)を復元します。成功時には復元されたオブジェクトを返しますが、失敗時にはfalseを返し、PHPが警告(E_WARNING)を発する場合があります。

コードでは、まず正常なデシリアライズ例を示し、正しくArrayObjectが復元されることを確認しています。その後は、意図的に破損させたデータや、シリアライズ形式ではない全く異なる文字列をunserialize()に渡した場合に、デシリアライズが失敗しfalseが返される挙動を示しています。このように、unserialize()の戻り値がfalseであるかをif文で確認することは、不正なデータによるセキュリティリスクや予期せぬ動作を防ぐ上で非常に重要です。常に結果を検証し、エラーを適切に処理しましょう。

PHPのunserialize関数は、シリアライズされた文字列データからオブジェクトなどを復元する際に利用されますが、いくつかの重要な注意点があります。デシリアライズが失敗した場合はfalseを返しますので、必ず=== falseで厳密に確認し、エラー処理を適切に行う必要があります。不正なデータを与えると、PHPは警告(E_WARNING)を発行する場合がありますが、この場合も戻り値がfalseになるため、戻り値の確認が基本です。最も重要なのはセキュリティ面で、信頼できない外部からのデータをunserializeに直接渡すと、オブジェクトインジェクションといった深刻な脆弱性を引き起こす可能性がありますので、絶対に避けてください。ArrayObjectなどの特定の型を復元する際は、instanceofでデシリアライズ後の型が期待通りか確認することも安全のために推奨されます。

関連コンテンツ