【PHP8.x】Dom\EntityReference::__sleep()メソッドの使い方

Copy
1<?php
2
3/**
4 * Dom\EntityReference オブジェクトのシリアライズを試みるクラス
5 *
6 * DOM関連のクラスは、C言語レベルで実装された内部リソースへのポインタを
7 * 保持しているため、PHPの `serialize()` 関数でシリアライズすることができません。
8 *
9 * `serialize()` を呼び出すと、オブジェクトの状態を保存するために `__sleep()`
10 * マジックメソッドが内部的に呼び出されますが、DOMオブジェクトの場合は
11 * シリアライズ自体が不可能なため、`__sleep()` は期待通りに機能せず、
12 * 例外がスローされます。
13 *
14 * このコードは、`Dom\EntityReference` オブジェクトをシリアライズしようとすると
15 * 意図通りに失敗すること（__sleepが効かない状況）を実証します。
16 */
17class DomSerializerExample
18{
19    /**
20     * Dom\EntityReferenceのシリアライズを試み、失敗することを実証します。
21     */
22    public static function demonstrate(): void
23    {
24        // エンティティを定義したXML文字列
25        $xmlString = <<<XML
26        <?xml version="1.0" encoding="UTF-8"?>
27        <!DOCTYPE root [
28            <!ENTITY myEntity "entity text">
29        ]>
30        <root>
31            <child>&myEntity;</child>
32        </root>
33        XML;
34
35        // DOMDocumentオブジェクトを作成し、XMLを読み込みます
36        $dom = new DOMDocument();
37        $dom->loadXML($xmlString);
38
39        // <child>タグの最初の子ノードであるエンティティ参照ノードを取得します
40        // このノードのクラスは Dom\EntityReference です
41        $entityRefNode = $dom->getElementsByTagName('child')->item(0)?->firstChild;
42
43        if (!$entityRefNode instanceof \Dom\EntityReference) {
44            echo "Failed to get Dom\EntityReference node." . PHP_EOL;
45            return;
46        }
47
48        echo 'Target object class: ' . get_class($entityRefNode) . PHP_EOL;
49
50        try {
51            // Dom\EntityReference オブジェクトをシリアライズしようと試みます。
52            // これにより、内部的に __sleep() が呼び出されるはずですが、
53            // DOMノードはシリアライズ不可能なため、Exceptionが発生します。
54            echo 'Attempting to serialize...' . PHP_EOL;
55            $serialized = serialize($entityRefNode);
56
57            // この行は実行されません
58            echo 'Serialization successful.' . PHP_EOL;
59        } catch (Exception $e) {
60            // 期待通りに例外がキャッチされます
61            echo 'Serialization failed as expected.' . PHP_EOL;
62            echo 'Error: ' . $e->getMessage() . PHP_EOL;
63        }
64    }
65}
66
67// 実証用のメソッドを実行します
68DomSerializerExample::demonstrate();

このPHPコードは、Dom\EntityReference オブジェクトに対して __sleep メソッドが期待通りに機能しない状況を実証します。__sleep は、serialize 関数でオブジェクトを文字列に変換して保存（シリアライズ）する際に、どのプロパティを保存するかを指定するためのマジックメソッドです。このメソッドは引数を取らず、保存対象のプロパティ名を配列で返すのが本来の役割です。

しかし、Dom\EntityReference のようなDOM関連のオブジェクトは、PHPの内部で特殊なリソースを管理しているため、serialize 関数によるシリアライズ自体ができません。

サンプルコードでは、XMLからエンティティ参照ノード（Dom\EntityReference オブジェクト）を取得し、それを serialize しようと試みています。この操作により、オブジェクトの状態を保存するために内部的に __sleep が呼び出されることが期待されますが、オブジェクトがシリアライズ非対応であるため、処理は失敗し、例外が発生します。これは、__sleep メソッドに問題があるのではなく、対象オブジェクトの特性によるものです。このように、特定の内部リソースを持つオブジェクトではシリアライズが制限されるため、__sleep が意図した通りに動作しないことがあります。

Copy
1<?php
2
3/**
4 * 指定されたミリ秒だけプログラムの実行を一時停止します。
5 *
6 * PHPの標準関数 `usleep()` はマイクロ秒（100万分の1秒）単位で時間を指定します。
7 * この関数は、より直感的なミリ秒（1000分の1秒）で待機時間を指定できるようにします。
8 *
9 * @param int $milliseconds 待機する時間（ミリ秒単位）。
10 * @return void
11 */
12function sleepMilliseconds(int $milliseconds): void
13{
14    // 開始時刻をマイクロ秒まで取得
15    $startTime = microtime(true);
16    echo "処理を開始します。現在時刻: " . date('H:i:s') . substr((string)$startTime, 10) . PHP_EOL;
17    echo "{$milliseconds}ミリ秒待機します..." . PHP_EOL;
18
19    // usleepはマイクロ秒単位で引数を取るため、ミリ秒を1000倍する
20    // 負の値や0が指定された場合は何もしない
21    if ($milliseconds > 0) {
22        usleep($milliseconds * 1000);
23    }
24
25    // 終了時刻をマイクロ秒まで取得
26    $endTime = microtime(true);
27    echo "処理を再開しました。現在時刻: " . date('H:i:s') . substr((string)$endTime, 10) . PHP_EOL;
28
29    // 実際の経過時間を計算して表示
30    $elapsedTime = ($endTime - $startTime) * 1000;
31    echo sprintf("実際の経過時間: %.2f ミリ秒", $elapsedTime) . PHP_EOL;
32}
33
34// 関数の実行例
35sleepMilliseconds(1500); // 1500ミリ秒 (1.5秒) 待機する
36
37?>

このPHPコードは、指定した時間（ミリ秒単位）だけプログラムの実行を一時停止する、sleepMilliseconds という独自の関数を定義したサンプルです。PHPには標準で秒単位で待機するsleep()関数や、より細かいマイクロ秒（100万分の1秒）単位で待機するusleep()関数が用意されています。このサンプルコードは、usleep()を応用することで、開発者にとってより直感的に分かりやすいミリ秒（1000分の1秒）単位で待機時間を指定できるようにしたものです。

sleepMilliseconds関数は、引数$millisecondsに待機させたい時間をミリ秒単位の整数で受け取ります。関数の内部では、受け取ったミリ秒の値を1000倍してマイクロ秒に変換し、それをusleep()関数に渡すことで目的の待機時間を実現しています。この関数は特定の値を返さないため、戻り値の型はvoidと定義されています。

サンプルコードの最後では、sleepMilliseconds(1500)と関数を呼び出すことで、実際に1500ミリ秒（1.5秒）間プログラムを停止させています。また、処理の開始・再開時刻と実際の経過時間を表示しており、関数が意図通りに動作していることを分かりやすく確認できます。