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

Copy
1<?php
2
3// PHPのSplStackクラスのシリアライズと、php.ini の serialize_precision 設定の影響を示すサンプルコード。
4// SplStack::serialize() は、serialize() 関数に SplStack オブジェクトを渡した際に内部的に呼び出されます。
5
6// SplStack のインスタンスを作成
7$stack = new SplStack();
8
9// スタックに様々な型のデータを追加
10$stack->push('Hello SplStack');
11$stack->push(12345);
12$stack->push(true);
13
14// 浮動小数点数を追加します。この値が serialize_precision の影響を最も受けます。
15$floatValue = 3.141592653589793; // 意図的に高精度な浮動小数点数を使用
16$stack->push($floatValue);
17$stack->push(['array', 'data']); // 配列も追加
18
19// --- 元の SplStack の内容を表示 (LIFO順) ---
20echo "--- 元の SplStack の内容 (LIFO順) ---\n";
21// 表示用にスタックをクローンし、元のスタックは変更しない
22$tempStack = clone $stack;
23while (!$tempStack->isEmpty()) {
24    $item = $tempStack->pop(); // topから要素をpopで取り出す
25    echo "  - " . (is_scalar($item) ? (string)$item : gettype($item)) . "\n";
26}
27echo "\n";
28
29
30// --- serialize_precision の影響を確認 ---
31
32// 1. 低い serialize_precision 設定でのシリアライズ
33// ini_set() を使用して、現在のスクリプト実行中に一時的に浮動小数点数の精度設定を変更します。
34ini_set('serialize_precision', 5); // 精度を5桁に設定
35
36echo "--- serialize_precision が " . ini_get('serialize_precision') . " の場合 ---\n";
37// serialize() 関数を呼び出すと、SplStack::serialize() が内部的に使用されます。
38$serializedStackLowPrecision = serialize($stack);
39echo "シリアライズ結果:\n";
40echo $serializedStackLowPrecision . "\n";
41echo "注目点: 浮動小数点数 (" . $floatValue . ") が丸められて表現されています。\n\n";
42
43// 2. 高い serialize_precision 設定でのシリアライズ
44// 浮動小数点数の完全な精度 (通常17桁) に設定し直します。
45ini_set('serialize_precision', 17);
46
47echo "--- serialize_precision が " . ini_get('serialize_precision') . " の場合 ---\n";
48$serializedStackHighPrecision = serialize($stack);
49echo "シリアライズ結果:\n";
50echo $serializedStackHighPrecision . "\n";
51echo "注目点: 浮動小数点数 (" . $floatValue . ") がより高い精度で保持されています。\n\n";
52
53?>

SplStack::serializeメソッドは、PHPのSplStackオブジェクトを、後で元の状態に復元できる形式の文字列（シリアライズデータ）に変換する際に内部的に利用される特殊なメソッドです。このメソッドは直接引数を受け取らず、SplStackオブジェクトが持つ全ての要素と構造を表現したstring型のデータを返します。通常、開発者がこのメソッドを直接呼び出すことはなく、PHPの標準関数であるserialize()にSplStackオブジェクトを渡した際に自動的に実行されます。

シリアライズの挙動において重要なのは、PHPの設定であるserialize_precisionディレクティブです。この設定は、特に浮動小数点数がシリアライズされる際の精度の桁数を決定します。サンプルコードでは、このserialize_precisionの値を変更することで、同じ浮動小数点数を含むSplStackオブジェクトが、異なる精度でシリアライズされる様子を示しています。値が低い設定では浮動小数点数が丸められて表現されるため、高精度な浮動小数点数を扱う場合には、この設定がデータの正確性に大きく影響することを理解しておく必要があります。これにより、SplStackオブジェクトをファイル保存やネットワーク経由でやり取りする際のデータの整合性を適切に保つことができます。

Copy
1<?php
2
3/**
4 * SplStackクラスのシリアライズとデシリアライズの処理を実演する関数です。
5 *
6 * SplStackは、PHPの標準ライブラリ（SPL）で提供される、
7 * 後入れ先出し（LIFO: Last-In, First-Out）のデータ構造であるスタックを実装したクラスです。
8 *
9 * SplStack::serialize() メソッドは、スタックの内容を文字列形式に変換し、
10 * unserialize() グローバル関数は、その文字列から元のスタックを復元します。
11 */
12function demonstrateSplStackSerialization(): void
13{
14    echo "--- SplStackのシリアライズとデシリアライズのデモンストレーション ---" . PHP_EOL;
15
16    // 1. SplStackインスタンスの作成とデータの追加
17    echo PHP_EOL . "1. オリジナルのSplStackを作成し、データを追加します。" . PHP_EOL;
18    $originalStack = new SplStack();
19    $originalStack->push('最初のデータ');    // 最初に追加
20    $originalStack->push(123);               // 次に追加
21    $originalStack->push(['キー' => '値']);  // 最後に追加
22
23    echo "  元のスタックの要素数: " . count($originalStack) . PHP_EOL;
24    // スタックの内容を、実際にpopする順序（LIFO）で確認します。
25    // SplStackはIteratorAggregateを実装しているため、foreachで巡回できますが、
26    // ここでは一時的に配列にコピーしてLIFO順序を明示します。
27    $tempArray = [];
28    foreach ($originalStack as $item) {
29        $tempArray[] = var_export($item, true);
30    }
31    echo "  元のスタックの内容 (popされる順): " . implode(', ', $tempArray) . PHP_EOL;
32
33    // 2. SplStack::serialize() メソッドを使ってスタックをシリアライズ
34    echo PHP_EOL . "2. SplStack::serialize() を使ってスタックをシリアライズします。" . PHP_EOL;
35    $serializedStack = $originalStack->serialize();
36
37    echo "  シリアライズされた文字列: " . $serializedStack . PHP_EOL;
38    echo "  シリアライズされた文字列の長さ: " . strlen($serializedStack) . " バイト" . PHP_EOL;
39
40    // 3. unserialize() 関数を使ってスタックをデシリアライズ（復元）
41    echo PHP_EOL . "3. unserialize() を使ってスタックをデシリアライズ（復元）します。" . PHP_EOL;
42    /** @var SplStack $deserializedStack */
43    $deserializedStack = unserialize($serializedStack);
44
45    // デシリアライズが成功し、SplStackインスタンスが復元されたかを確認
46    if ($deserializedStack instanceof SplStack) {
47        echo "  デシリアライズに成功し、SplStackインスタンスが復元されました。" . PHP_EOL;
48        echo "  復元されたスタックの要素数: " . count($deserializedStack) . PHP_EOL;
49
50        // 4. 復元されたスタックからデータを取り出し、元のデータと比較
51        echo PHP_EOL . "4. 復元されたスタックからデータを取り出し、元のスタックと比較します。" . PHP_EOL;
52
53        echo "  復元されたスタックから要素をpopします (LIFO順):" . PHP_EOL;
54
55        // 最後に追加したデータが最初に取り出される (LIFO)
56        $item3 = $deserializedStack->pop();
57        echo "  Popされた要素1: " . var_export($item3, true) . PHP_EOL; // 期待値: ['キー' => '値']
58
59        $item2 = $deserializedStack->pop();
60        echo "  Popされた要素2: " . var_export($item2, true) . PHP_EOL; // 期待値: 123
61
62        $item1 = $deserializedStack->pop();
63        echo "  Popされた要素3: " . var_export($item1, true) . PHP_EOL; // 期待値: '最初のデータ'
64
65        echo "  復元されたスタックの要素数 (全てpop後): " . count($deserializedStack) . PHP_EOL;
66
67    } else {
68        echo "  エラー: デシリアライズに失敗しました。復元されたのはSplStackインスタンスではありません。" . PHP_EOL;
69    }
70
71    echo PHP_EOL . "--- デモンストレーション終了 ---" . PHP_EOL;
72}
73
74// 関数の実行
75demonstrateSplStackSerialization();

PHPのSplStackは、後入れ先出し（LIFO）の原則でデータを管理するスタック構造を提供するクラスです。SplStack::serialize()メソッドは、このSplStackインスタンスの現在の状態、つまり中に保持されているすべてのデータとその順序を、一つの文字列形式に変換する役割を持ちます。このメソッドは引数を必要とせず、処理の結果としてスタックの情報をエンコードしたstring型のデータを返します。

生成されたシリアライズ済み文字列は、PHPのグローバル関数であるunserialize()に渡すことで、元のSplStackインスタンスとして正確に復元することが可能です。サンプルコードでは、最初にいくつかの異なるデータをSplStackに追加し、serialize()を使ってそのスタック全体を文字列に変換しています。その後、この文字列をunserialize()で復元された新しいSplStackインスタンスからデータを取り出し、元のスタックと同じLIFOの順序と内容でデータが取得できることを示しています。このように、serialize()とunserialize()の組み合わせは、SplStackオブジェクトの状態をファイルに保存したり、異なるPHPプロセス間で受け渡したりする際に非常に便利です。