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

Copy
1<?php
2
3class MyDateTime extends DateTime
4{
5    public int $customProperty;
6
7    public function __construct(string $datetime = 'now', ?DateTimeZone $timezone = null)
8    {
9        parent::__construct($datetime, $timezone);
10        $this->customProperty = 0; // 初期値を設定
11    }
12
13    public function __unserialize(array $data): void
14    {
15        // DateTimeクラスの親クラスのアンシリアライズ処理を実行
16        parent::__unserialize($data);
17
18        // カスタムプロパティを復元
19        $this->customProperty = $data['customProperty'];
20    }
21
22    public function __serialize(): array
23    {
24        // DateTimeクラスの親クラスのシリアライズ処理を実行
25        $data = parent::__serialize();
26
27        // カスタムプロパティをシリアライズ
28        $data['customProperty'] = $this->customProperty;
29
30        return $data;
31    }
32}
33
34// MyDateTimeオブジェクトの作成とカスタムプロパティの設定
35$originalDateTime = new MyDateTime();
36$originalDateTime->customProperty = 123;
37
38// シリアライズ
39$serializedData = serialize($originalDateTime);
40
41// アンシリアライズ
42/** @var MyDateTime $unserializedDateTime */
43$unserializedDateTime = unserialize($serializedData);
44
45// 結果の確認
46echo "Original DateTime: " . $originalDateTime->format('Y-m-d H:i:s') . ", Custom Property: " . $originalDateTime->customProperty . "\n";
47echo "Unserialized DateTime: " . $unserializedDateTime->format('Y-m-d H:i:s') . ", Custom Property: " . $unserializedDateTime->customProperty . "\n";
48
49?>

PHP 8のDateTimeクラスにおける__unserializeメソッドは、unserialize()関数によってオブジェクトが復元される際に自動的に呼ばれる特別なメソッドです。このメソッドを使用することで、オブジェクトのシリアライズされたデータから、オブジェクトの状態を復元する処理をカスタマイズできます。

このサンプルコードでは、DateTimeクラスを継承したMyDateTimeクラスを定義しています。MyDateTimeクラスは、標準のDateTimeクラスに加えて、customPropertyというカスタムプロパティを持っています。

__unserializeメソッド内では、まず親クラスであるDateTimeクラスの__unserializeメソッドを呼び出し、基本的なDateTimeオブジェクトの状態を復元します。その後、$data引数からcustomPropertyの値を読み取り、オブジェクトのcustomPropertyプロパティに設定します。これにより、シリアライズされたデータに含まれるカスタムプロパティの値が、アンシリアライズ後のオブジェクトに正しく復元されます。

引数$dataは、serialize()関数によって生成された配列形式のデータです。この配列には、オブジェクトのプロパティとその値が格納されています。戻り値はvoidで、特に値を返す必要はありません。unserialize()関数がオブジェクトの復元処理を完了させます。

この例では、__serializeメソッドも定義されており、オブジェクトがシリアライズされる際にcustomPropertyの値も保存されるようにしています。serializeとunserializeを組み合わせることで、オブジェクトの状態を完全に保存・復元できます。このメカニズムは、データベースへのオブジェクトの保存や、セッション管理など、様々な場面で活用できます。

Copy
1<?php
2
3class MyDateTime extends DateTime
4{
5    public function __unserialize(array $data): void
6    {
7        try {
8            parent::__unserialize($data);
9        } catch (Exception $e) {
10            // unserialize に失敗した場合の処理
11            // 例: デフォルト値の設定、ログ出力など
12
13            // エラーメッセージの取得
14            $errorMessage = $e->getMessage();
15
16            // ログ出力
17            error_log("Failed to unserialize MyDateTime object: " . $errorMessage);
18
19            // デフォルト値で初期化 (例: 現在時刻)
20            parent::__construct();
21
22            // または、例外を再スローする (必要に応じて)
23            // throw new Exception("Failed to unserialize MyDateTime object.", 0, $e);
24        }
25    }
26}
27
28// シリアライズされたデータの例 (不正なデータを含む)
29$serializedData = 'O:10:"MyDateTime":1:{s:4:"date";s:27:"9999-99-99 99:99:99.000000";s:13:"timezone_type";i:3;s:8:"timezone";s:3:"UTC";};';
30
31// unserialize 処理
32$myDateTime = unserialize($serializedData);
33
34// 結果の確認
35if ($myDateTime instanceof MyDateTime) {
36    echo "MyDateTime object unserialized successfully.\n";
37    echo $myDateTime->format('Y-m-d H:i:s') . "\n";
38} else {
39    echo "Failed to unserialize MyDateTime object.\n";
40}

このサンプルコードは、PHPのDateTimeクラスを拡張したMyDateTimeクラスで、__unserializeマジックメソッドを使用して、オブジェクトのアンシリアライズ処理をカスタマイズする方法を示しています。__unserializeは、unserialize()関数によってオブジェクトが復元される際に自動的に呼ばれるメソッドです。引数 $data は、シリアライズされたデータから復元された配列です。戻り値は void で、何も返しません。

この例では、parent::__unserialize($data) を呼び出して親クラスのDateTimeのアンシリアライズ処理を実行し、もしDateTimeのアンシリアライズに失敗した場合（例えば、シリアライズされたデータが不正な形式の場合）、try-catchブロックで例外を捕捉しています。

catchブロック内では、エラーメッセージをログに出力したり、オブジェクトをデフォルト値で初期化したり、必要に応じて例外を再スローしたりすることができます。サンプルコードでは、不正な日付データを含むシリアライズされた文字列をunserialize()関数に渡し、エラー発生時の処理をデモンストレーションしています。これにより、不正なデータによるエラーを適切に処理し、プログラムの安定性を高めることができます。