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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 指定した秒数だけプログラムの実行を一時停止するサンプルです。
7 *
8 * 1秒未満の小数でスリープ時間を指定する場合、
9 * 秒単位で指定する sleep() 関数ではなく、
10 * マイクロ秒単位で指定する usleep() 関数を使用します。
11 * (1秒 = 1,000,000マイクロ秒)
12 */
13function demonstrateMicrosecondSleep(): void
14{
15    // 待機する秒数
16    $secondsToSleep = 0.5;
17
18    echo '処理を開始します。' . PHP_EOL;
19    echo '現在時刻: ' . date('H:i:s') . PHP_EOL;
20
21    // 開始時刻のタイムスタンプを取得
22    $startTime = microtime(true);
23
24    // 秒数をマイクロ秒に変換 (0.5秒 = 500,000マイクロ秒)
25    $microseconds = (int)($secondsToSleep * 1_000_000);
26
27    // 指定したマイクロ秒数だけプログラムの実行を停止
28    usleep($microseconds);
29
30    // 終了時刻のタイムスタンプを取得
31    $endTime = microtime(true);
32
33    echo "{$secondsToSleep}秒の待機が完了しました。" . PHP_EOL;
34    echo '現在時刻: ' . date('H:i:s') . PHP_EOL;
35
36    // 実際の経過時間を計算して表示
37    $elapsedTime = $endTime - $startTime;
38    echo '実際の経過時間: ' . round($elapsedTime, 4) . '秒' . PHP_EOL;
39}
40
41// サンプル関数を実行
42demonstrateMicrosecondSleep();

このサンプルコードは、PHPでプログラムの実行を0.5秒間だけ一時停止する方法を示しています。PHPには実行を停止させる関数として sleep() がありますが、この関数は引数に整数秒しか指定できません。そのため、0.5秒のような1秒未満の時間を指定する場合には、マイクロ秒単位で時間を指定できる usleep() 関数を使用します。1秒は1,000,000マイクロ秒です。このコードでは、待機したい秒数である0.5に1,000,000を掛けることで、500,000マイクロ秒を算出しています。そして、この値を引数として usleep() 関数に渡すことで、プログラムの実行を正確に0.5秒間停止させています。処理の前後で時刻を取得して実際の経過時間を計算し、意図した通りに動作していることを確認できるようにしています。

Copy
1<?php
2
3/**
4 * 指定されたミリ秒だけプログラムの実行を一時停止します。
5 *
6 * PHPの標準関数 usleep() はマイクロ秒を引数に取るため、
7 * ミリ秒をマイクロ秒に変換して使用します (1ミリ秒 = 1000マイクロ秒)。
8 *
9 * @param int $milliseconds 待機する時間 (ミリ秒単位)
10 */
11function sleepForMilliseconds(int $milliseconds): void
12{
13    // 処理開始前の時刻をマイクロ秒まで取得
14    $startTime = microtime(true);
15    echo "処理開始: " . date('H:i:s') . substr((string)$startTime, 10, 4) . PHP_EOL;
16
17    // 待機時間をコンソールに出力
18    echo "{$milliseconds}ミリ秒待機します..." . PHP_EOL;
19
20    // ミリ秒をマイクロ秒に変換
21    $microseconds = $milliseconds * 1000;
22
23    // 指定されたマイクロ秒だけ実行を一時停止
24    usleep($microseconds);
25
26    // 処理終了後の時刻をマイクロ秒まで取得
27    $endTime = microtime(true);
28    echo "処理再開: " . date('H:i:s') . substr((string)$endTime, 10, 4) . PHP_EOL;
29
30    // 実際の経過時間を計算して表示
31    $elapsedTime = ($endTime - $startTime) * 1000;
32    echo "実際の経過時間: " . round($elapsedTime, 2) . "ミリ秒" . PHP_EOL;
33}
34
35// 関数を呼び出し、500ミリ秒 (0.5秒) 待機するサンプルを実行します。
36sleepForMilliseconds(500);
37

このサンプルコードは、PHPで指定したミリ秒（1000分の1秒）単位でプログラムの実行を一時停止する方法を示しています。PHPには秒単位で待機する sleep() 関数や、マイクロ秒（100万分の1秒）単位で待機する usleep() 関数が標準で用意されていますが、ミリ秒単位で直接指定できる関数はありません。

そこで、このコードでは sleepForMilliseconds という独自の関数を定義しています。この関数は、引数として待機したい時間をミリ秒単位の整数で受け取ります。関数内部では、受け取ったミリ秒の値を1000倍してマイクロ秒に変換し、その結果を usleep() 関数に渡すことで、ミリ秒単位での待機を実現しています。この関数は特定の値を返さないため、戻り値の型は void となっています。

コードの最後では sleepForMilliseconds(500) を呼び出し、実際に500ミリ秒（0.5秒）間、処理を停止させています。また、処理の開始時刻と再開時刻、そして実際の経過時間をコンソールに出力することで、意図した時間だけプログラムが正確に停止していることを視覚的に確認できるようになっています。