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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * php.ini の `serialize_precision` 設定が
7 * DatePeriod オブジェクトのシリアライズに与える影響を示します。
8 *
9 * DatePeriod::__serialize() は serialize() 関数によって内部的に呼び出され、
10 * オブジェクトの状態を配列として返します。この際、保持している日時情報
11 * (DateTimeImmutable) のシリアライズに `serialize_precision` が影響します。
12 */
13function demonstrateDatePeriodSerializationWithPrecision(): void
14{
15    // 1. マイクロ秒を含む日時でDatePeriodオブジェクトを生成します。
16    // DateTimeImmutableは内部的にマイクロ秒を浮動小数点数として扱います。
17    $start = new DateTimeImmutable('2023-01-01 12:34:56.123456');
18    $interval = new DateInterval('P1D');
19    $end = new DateTimeImmutable('2023-01-03 12:34:56.987654');
20    $datePeriod = new DatePeriod($start, $interval, $end);
21
22    // 2. デフォルトの `serialize_precision` 設定でシリアライズします。
23    // 通常、デフォルト値は17で、浮動小数点数の情報を失うことなく表現できます。
24    $originalPrecision = ini_get('serialize_precision');
25    echo "--- デフォルト設定 (serialize_precision: {$originalPrecision}) ---\n";
26    $serializedDefault = serialize($datePeriod);
27    echo $serializedDefault . "\n\n";
28    
29    // 3. `ini_set()` を使い、実行時に `serialize_precision` の値を変更します。
30    // ここでは精度を意図的に下げてみます。
31    ini_set('serialize_precision', '3');
32    $newPrecision = ini_get('serialize_precision');
33    echo "--- 変更後の設定 (serialize_precision: {$newPrecision}) ---\n";
34
35    // 4. 変更後の設定で再度シリアライズし、結果を比較します。
36    // シリアライズ結果の日時を表す浮動小数点数の桁数が短くなっていることがわかります。
37    $serializedChanged = serialize($datePeriod);
38    echo $serializedChanged . "\n\n";
39
40    // 5. スクリプトの他の部分に影響を与えないよう、設定を元に戻します。
41    ini_set('serialize_precision', $originalPrecision);
42}
43
44// 関数を実行して結果を表示します。
45demonstrateDatePeriodSerializationWithPrecision();

DatePeriod::__serializeメソッドは、serialize()関数でDatePeriodオブジェクトをシリアル化（保存や転送が可能な文字列形式に変換すること）する際に、内部的に呼び出されます。このメソッドは引数を取らず、オブジェクトの状態（開始日時、間隔、終了日時など）を表現する配列を返します。

このサンプルコードは、PHPの設定項目であるserialize_precisionが、DatePeriodオブジェクトのシリアル化に与える影響を示しています。DatePeriodが内部で保持する日時情報（DateTimeImmutableオブジェクト）は、マイクロ秒を浮動小数点数として扱います。serialize_precisionは、この浮動小数点数を文字列に変換する際の有効桁数を指定する設定です。

コードではまず、デフォルト設定でDatePeriodオブジェクトをシリアル化します。次にini_set()関数でserialize_precisionの値を意図的に小さくして再度シリアル化し、結果を比較しています。設定変更後は、シリアル化された文字列内の日時を表す数値の小数点以下の桁数が減り、精度が落ちていることが確認できます。このように、__serializeが返すデータを元に生成される最終的な文字列は、PHPの実行環境の設定に影響を受けます。

Copy
1<?php
2
3// DatePeriodオブジェクトのシリアライズとアンシリアライズのサンプルコード
4
5// 1. DatePeriodオブジェクトを作成します。
6// これは、指定された開始日時から終了日時まで、指定された間隔で繰り返される日付の期間を表します。
7$startDate = new DateTimeImmutable('2023-01-01');
8$interval = new DateInterval('P1D'); // 1日間の間隔
9$endDate = new DateTimeImmutable('2023-01-05'); // 2023-01-01, 02, 03, 04 の4つの日付を含む期間
10
11$originalPeriod = new DatePeriod($startDate, $interval, $endDate);
12
13echo "元のDatePeriodオブジェクトの内容:\n";
14foreach ($originalPeriod as $date) {
15    echo "  " . $date->format('Y-m-d') . "\n";
16}
17echo "\n";
18
19// 2. DatePeriodオブジェクトをシリアライズします。
20// PHPのserialize()関数は内部的にDatePeriod::__serialize()マジックメソッドを呼び出します。
21// このメソッドは、オブジェクトの状態を表す配列を返し、その配列が文字列に変換されます。
22$serializedPeriod = serialize($originalPeriod);
23
24echo "シリアライズされた文字列:\n";
25echo $serializedPeriod . "\n\n";
26
27// 3. シリアライズされた文字列からDatePeriodオブジェクトをアンシリアライズします。
28// PHPのunserialize()関数は内部的にDatePeriod::__unserialize()マジックメソッドを呼び出します。
29// このメソッドは、シリアライズされたデータからオブジェクトの内部状態を復元します。
30$unserializedPeriod = unserialize($serializedPeriod);
31
32echo "アンシリアライズされたDatePeriodオブジェクトの内容:\n";
33if ($unserializedPeriod instanceof DatePeriod) {
34    foreach ($unserializedPeriod as $date) {
35        echo "  " . $date->format('Y-m-d') . "\n";
36    }
37} else {
38    echo "  アンシリアライズに失敗しました。\n";
39}
40echo "\n";
41
42// 4. 元のオブジェクトと復元されたオブジェクトが同じ期間を表しているか簡単な検証を行います。
43// DatePeriodオブジェクトはイテレータなので、要素数を比較します。
44$originalCount = iterator_count($originalPeriod);
45$unserializedCount = iterator_count($unserializedPeriod);
46
47echo "元のオブジェクトの要素数: " . $originalCount . "\n";
48echo "復元されたオブジェクトの要素数: " . $unserializedCount . "\n";
49
50if ($originalCount === $unserializedCount) {
51    echo "元のオブジェクトと復元されたオブジェクトの要素数は一致します。シリアライズ/アンシリアライズは成功しました。\n";
52} else {
53    echo "要素数が一致しません。シリアライズ/アンシリアライズに問題がある可能性があります。\n";
54}
55
56?>

PHP 8から導入されたDatePeriod::__serializeメソッドは、DatePeriodオブジェクトを永続化（保存したり、別の場所へ送ったり）するために使用される特別な「マジックメソッド」です。PHPの標準関数であるserialize()を使ってDatePeriodオブジェクトを文字列に変換する際、内部的にこの__serializeメソッドが自動的に呼び出されます。

__serializeメソッドは引数を取りません。その役割は、現在のDatePeriodオブジェクトの重要な状態（開始日時、間隔、終了日時など）を表現するarray（配列）を返すことです。この配列の情報が、serialize()関数によって最終的に一つの文字列に変換されます。

このシリアライズされた文字列は、後でunserialize()関数を使って元のDatePeriodオブジェクトとして復元できます。unserialize()が機能する際には、内部的にDatePeriod::__unserializeというメソッドが呼び出され、__serializeが返した配列のデータをもとにオブジェクトの状態が再現されます。この仕組みにより、複雑なDatePeriodオブジェクトも簡単に保存・転送し、再利用することが可能になります。サンプルコードは、この一連の流れでオブジェクトが正しくシリアライズされ、復元されることを示しています。