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

Copy
1<?php
2
3/**
4 * DateTimeImmutable::__serialize() のサンプルコード
5 * serialize_precision の設定による影響を確認する
6 */
7class DateTimeImmutableSerializer
8{
9    public function serializeDateTime(DateTimeImmutable $dateTime): string
10    {
11        return serialize($dateTime);
12    }
13
14    public function unserializeDateTime(string $serialized): DateTimeImmutable
15    {
16        return unserialize($serialized);
17    }
18}
19
20// serialize_precision のデフォルト値を使用
21ini_set('serialize_precision', -1); // デフォルト値
22
23$dateTime = new DateTimeImmutable('2024-01-01 10:20:30.123456');
24$serializer = new DateTimeImmutableSerializer();
25$serialized = $serializer->serializeDateTime($dateTime);
26$unserialized = $serializer->unserializeDateTime($serialized);
27
28echo "デフォルト serialize_precision:\n";
29echo "元のDateTime: " . $dateTime->format('Y-m-d H:i:s.u') . "\n";
30echo "シリアライズされた文字列: " . $serialized . "\n";
31echo "アンシリアライズされたDateTime: " . $unserialized->format('Y-m-d H:i:s.u') . "\n";
32
33// serialize_precision を変更
34ini_set('serialize_precision', 3);
35
36$dateTime = new DateTimeImmutable('2024-01-01 10:20:30.123456');
37$serialized = $serializer->serializeDateTime($dateTime);
38$unserialized = $serializer->unserializeDateTime($serialized);
39
40echo "\nserialize_precision = 3:\n";
41echo "元のDateTime: " . $dateTime->format('Y-m-d H:i:s.u') . "\n";
42echo "シリアライズされた文字列: " . $serialized . "\n";
43echo "アンシリアライズされたDateTime: " . $unserialized->format('Y-m-d H:i:s.u') . "\n";

DateTimeImmutable::__serialize() は、PHP 8 で DateTimeImmutable オブジェクトをシリアライズ（文字列に変換）する際に内部的に呼ばれるメソッドです。このメソッドは引数を取らず、シリアライズに必要なデータを含む配列を返します。

このサンプルコードでは、DateTimeImmutable オブジェクトのシリアライズとアンシリアライズ（文字列からオブジェクトへの復元）の過程で、serialize_precision という PHP の設定値がどのように影響するかを示しています。serialize_precision は、シリアライズされた浮動小数点数の精度を制御します。デフォルトでは -1 に設定されており、最大限の精度が保持されます。

コードでは、まず serialize_precision をデフォルト値の -1 に設定し、DateTimeImmutable オブジェクトをシリアライズ、アンシリアライズしています。次に、serialize_precision を 3 に変更し、同様の処理を行います。

出力結果を比較することで、serialize_precision の値によって、シリアライズされた文字列に含まれるマイクロ秒以下の精度が変化することを確認できます。serialize_precision を小さくすると、シリアライズされる際の精度が落ちるため、アンシリアライズ後の DateTimeImmutable オブジェクトのマイクロ秒以下の値が元の値と異なる場合があります。この設定は、データの保存や伝送において、精度とデータサイズのバランスを取る際に重要になります。

Copy
1<?php
2
3/**
4 * DateTimeImmutable::__serialize() のサンプルコード
5 */
6class MyDateTime extends DateTimeImmutable
7{
8    private string $extraData;
9
10    public function __construct(string $datetime = "now", DateTimeZone $timezone = null, string $extraData = "")
11    {
12        parent::__construct($datetime, $timezone);
13        $this->extraData = $extraData;
14    }
15
16    public function getExtraData(): string
17    {
18        return $this->extraData;
19    }
20
21    public function __serialize(): array
22    {
23        // 親クラスのシリアライズ結果を取得
24        $parentData = parent::__serialize();
25
26        // 独自のデータを追加
27        $data = [
28            'parent' => $parentData,
29            'extraData' => $this->extraData,
30        ];
31
32        return $data;
33    }
34
35    public function __unserialize(array $data): void
36    {
37        // 独自のデータを復元
38        $this->extraData = $data['extraData'];
39
40        // 親クラスのアンシリアライズを実行
41        parent::__unserialize($data['parent']);
42    }
43}
44
45// オブジェクトの作成と初期化
46$dateTime = new MyDateTime('2024-01-01 10:00:00', new DateTimeZone('Asia/Tokyo'), 'Some extra info');
47
48// シリアライズ
49$serialized = serialize($dateTime);
50
51// アンシリアライズ
52$unserialized = unserialize($serialized);
53
54// 結果の確認
55echo "Original DateTime: " . $dateTime->format('Y-m-d H:i:s T') . " Extra data: " . $dateTime->getExtraData() . PHP_EOL;
56echo "Unserialized DateTime: " . $unserialized->format('Y-m-d H:i:s T') . " Extra data: " . $unserialized->getExtraData() . PHP_EOL;

このサンプルコードは、PHP 8のDateTimeImmutableクラスを拡張し、__serialize()メソッドと__unserialize()メソッドを実装することで、オブジェクトのシリアライズとアンシリアライズ処理をカスタマイズする方法を示しています。

DateTimeImmutableは日付と時刻を扱うための不変クラスですが、この例ではMyDateTimeクラスでextraDataという独自のプロパティを追加しています。__serialize()メソッドは、serialize()関数が呼ばれた際に、オブジェクトをシリアライズ（文字列に変換）するために実行されます。ここでは、親クラス(DateTimeImmutable)のシリアライズ結果と、追加したextraDataを配列にまとめて返しています。戻り値の配列は、シリアライズされた文字列に変換されます。引数は特にありません。

一方、__unserialize()メソッドは、unserialize()関数が呼ばれた際に、シリアライズされた文字列からオブジェクトを復元するために実行されます。ここでは、__serialize()で作成された配列を受け取り、extraDataプロパティを復元した後、親クラスのアンシリアライズ処理を呼び出しています。引数として、シリアライズされたデータから復元された配列を受け取ります。

この例では、MyDateTimeオブジェクトを作成し、シリアライズしてからアンシリアライズすることで、元のオブジェクトの状態が正しく保存され、復元されることを確認しています。この方法を使うことで、オブジェクトのシリアライズ/アンシリアライズ処理を細かく制御し、独自のデータを保存・復元できます。