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

Copy
1<?php
2
3/**
4 * DateTimeImmutable オブジェクトをシリアライズし、
5 * unserialize() 関数で復元するサンプルコード。
6 *
7 * unserialize() を呼び出すと、PHP の内部で自動的に
8 * DateTimeImmutable::__unserialize() メソッドが実行され、
9 * シリアライズされたデータからオブジェクトが再構築されます。
10 */
11function demonstrateDateTimeImmutableUnserialize(): void
12{
13    // タイムゾーンを設定します (実行環境による結果の差異をなくすため)
14    date_default_timezone_set('Asia/Tokyo');
15
16    // 1. 元となる DateTimeImmutable オブジェクトを生成します
17    $originalDate = new DateTimeImmutable('2025-01-01 12:34:56');
18    echo '元のオブジェクトの日時: ' . $originalDate->format(DateTimeInterface::ATOM) . PHP_EOL;
19
20    // 2. serialize() 関数でオブジェクトを文字列データに変換します
21    $serializedData = serialize($originalDate);
22    echo 'シリアライズされたデータ: ' . $serializedData . PHP_EOL;
23    echo '--------------------------------------------------' . PHP_EOL;
24
25    // 3. unserialize() 関数で文字列データからオブジェクトを復元します
26    // この関数の内部で DateTimeImmutable::__unserialize() が呼び出されます
27    $unserializedDate = unserialize($serializedData);
28
29    // 4. 復元されたオブジェクトが元の状態と同じであることを確認します
30    if ($unserializedDate instanceof DateTimeImmutable) {
31        echo '復元は成功しました。' . PHP_EOL;
32        echo '復元されたオブジェクトの日時: ' . $unserializedDate->format(DateTimeInterface::ATOM) . PHP_EOL;
33
34        // 元のオブジェクトと復元されたオブジェクトが等しいか比較します
35        if ($originalDate == $unserializedDate) {
36            echo '元のオブジェクトと復元されたオブジェクトは等しいです。' . PHP_EOL;
37        }
38    } else {
39        echo '復元に失敗しました。' . PHP_EOL;
40    }
41}
42
43// 関数を実行してデモを表示します
44demonstrateDateTimeImmutableUnserialize();
45

PHPのDateTimeImmutable::__unserialize()は、unserialize()関数が実行された際に、PHPによって内部で自動的に呼び出される特殊なメソッドです。プログラマーがこのメソッドを直接呼び出すことは通常ありません。その主な役割は、serialize()関数によって文字列に変換されたDateTimeImmutableオブジェクトを、元の状態に復元（再構築）することです。

このメソッドは、引数として $data という配列を受け取ります。この配列には、オブジェクトを復元するために必要な日時やタイムゾーンなどの情報が格納されています。__unserialize()メソッドは、このデータをもとにオブジェクトの内部状態を正しく設定し直します。

戻り値は void であり、何も返しません。値を返すのではなく、オブジェクト自体の状態を復元する処理を内部で完了させることが目的だからです。

サンプルコードでは、まずserialize()関数でDateTimeImmutableオブジェクトを文字列データに変換しています。次に、その文字列をunserialize()関数に渡すことで、内部的に__unserialize()メソッドが呼び出され、シリアライズされたデータから完全に同じ状態のDateTimeImmutableオブジェクトが再生成される流れを示しています。

Copy
1<?php
2
3/**
4 * DateTimeImmutableオブジェクトをシリアライズ・デシリアライズするサンプルです。
5 * 不正なデータでデシリアライズしようとするとエラーが発生する様子を示します。
6 *
7 * DateTimeImmutable::__unserialize() は、unserialize() 関数が内部で呼び出す
8 * マジックメソッドであり、開発者が直接呼び出すことは通常ありません。
9 */
10
11// 1. 正常なケース: オブジェクトをシリアライズし、正しく復元する
12
13// 元となるDateTimeImmutableオブジェクトを作成
14$originalDate = new DateTimeImmutable('2023-10-27 10:00:00', new DateTimeZone('Asia/Tokyo'));
15echo '--- 正常なケース ---' . PHP_EOL;
16echo '元のオブジェクト:' . PHP_EOL;
17var_dump($originalDate);
18
19// オブジェクトをシリアライズ（文字列に変換）
20$serializedString = serialize($originalDate);
21echo PHP_EOL . 'シリアライズされた文字列:' . PHP_EOL;
22echo $serializedString . PHP_EOL;
23
24// シリアライズされた文字列からオブジェクトを復元（デシリアライズ）
25$restoredDate = unserialize($serializedString);
26echo PHP_EOL . '復元されたオブジェクト:' . PHP_EOL;
27var_dump($restoredDate);
28
29
30// 2. エラーが発生するケース: 不正なデータで復元を試みる
31
32echo PHP_EOL . '--- エラーが発生するケース ---' . PHP_EOL;
33
34// シリアライズされた文字列の一部を意図的に破損させる
35// 本来の日付文字列 "2023-10-27 10:00:00.000000" を "invalid-data" に書き換える
36$corruptedString = str_replace(
37    '2023-10-27 10:00:00.000000',
38    'invalid-data',
39    $serializedString
40);
41
42echo '破損したシリアライズ文字列:' . PHP_EOL;
43echo $corruptedString . PHP_EOL . PHP_EOL;
44
45// 破損した文字列をデシリアライズしようとすると、内部で__unserializeが失敗し、
46// 例外 (Error) が発生する
47try {
48    echo '破損した文字列から復元を試みます...' . PHP_EOL;
49    // この処理でエラーが発生するため、catchブロックに処理が移る
50    unserialize($corruptedString);
51} catch (Throwable $e) {
52    // 発生したエラーを捕捉してメッセージを表示
53    echo 'エラーが発生しました！' . PHP_EOL;
54    echo 'エラーメッセージ: ' . $e->getMessage() . PHP_EOL;
55}
56

DateTimeImmutable::__unserialize()は、unserialize()関数がシリアライズされた文字列からDateTimeImmutableオブジェクトを復元する際に、PHPによって内部的に呼び出される特殊なマジックメソッドです。開発者がこのメソッドを直接コーディングで呼び出すことは通常ありません。

このメソッドは、引数$dataとしてオブジェクトのプロパティ情報が格納された配列を受け取ります。その情報をもとにオブジェクトの状態を復元する役割を担っており、処理が完了しても何も値を返さないため、戻り値はvoidとなります。

サンプルコードの前半では、正常なDateTimeImmutableオブジェクトをserialize()で文字列化し、それをunserialize()で正しくオブジェクトに復元する一連の流れを示しています。

後半のエラーケースでは、シリアライズされた文字列の日付部分を意図的に不正な文字列に書き換えています。この破損したデータをunserialize()で復元しようとすると、内部で__unserialize()が不正なデータを受け取ることになります。結果としてオブジェクトの復元に失敗し、Error例外が発生します。このコードは、不正なデータによるデシリアライズがエラーを引き起こすことを実証するものです。