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

Copy
1<?php
2
3/**
4 * 指定した秒数だけプログラムの実行を一時停止する関数
5 *
6 * この関数は、usleep() を使用してプログラムの実行を0.5秒間停止させます。
7 * 実行前後のタイムスタンプを出力することで、実際に処理が停止したことを確認できます。
8 */
9function sleepForHalfSecond(): void
10{
11    // 処理開始前の時刻をマイクロ秒まで取得
12    $startTime = microtime(true);
13    echo '処理開始: ' . date('Y-m-d H:i:s') . substr((string)$startTime, 10) . PHP_EOL;
14
15    // 0.5秒 = 500,000マイクロ秒
16    // usleep() はマイクロ秒単位で停止時間を指定します (1秒 = 1,000,000マイクロ秒)。
17    $microsecondsToSleep = 500_000;
18
19    echo '0.5秒間スリープします...' . PHP_EOL;
20
21    // 実行を500,000マイクロ秒（0.5秒）一時停止
22    usleep($microsecondsToSleep);
23
24    // 処理再開後の時刻をマイクロ秒まで取得
25    $endTime = microtime(true);
26    echo '処理再開: ' . date('Y-m-d H:i:s') . substr((string)$endTime, 10) . PHP_EOL;
27
28    // 実際に経過した時間を計算して表示
29    $elapsedTime = $endTime - $startTime;
30    echo '経過時間: ' . round($elapsedTime, 4) . '秒' . PHP_EOL;
31}
32
33// 関数を実行します
34sleepForHalfSecond();

このPHPサンプルコードは、プログラムの実行を0.5秒間だけ一時停止する方法を示しています。中心的な役割を果たすのは usleep() という関数です。sleep() 関数が秒単位で時間を指定するのに対し、usleep() はより細かいマイクロ秒単位で時間を指定できるのが特徴です。1秒は1,000,000マイクロ秒に相当するため、コード内で0.5秒を表現するために引数として 500_000 という数値を渡しています。

このコードは、まず microtime(true) を使って処理開始前の正確な時刻を取得し、出力します。次に usleep(500_000) を呼び出してプログラムの実行を0.5秒間停止させます。処理が再開されると、再び microtime(true) で時刻を取得し、開始時刻との差を計算することで、実際にプログラムが意図した時間だけ停止したことを確認・表示しています。このように usleep() 関数を利用することで、秒未満の精密な時間制御が可能になります。サンプル内の sleepForHalfSecond 関数は、この一連の処理をまとめたもので、引数はなく、特定の値を返さないため戻り値の型は void となっています。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 指定されたミリ秒だけプログラムの実行を待機（スリープ）させるサンプル関数。
7 *
8 * @param int $milliseconds 待機する時間（ミリ秒単位）。
9 */
10function sleepMilliseconds(int $milliseconds): void
11{
12    // 開始時刻とメッセージを表示
13    $startTime = microtime(true);
14    echo "処理を開始します。" . PHP_EOL;
15    echo "現在時刻: " . date('H:i:s') . substr((string)$startTime, 10) . PHP_EOL;
16    echo "{$milliseconds}ミリ秒（" . ($milliseconds / 1000) . "秒）待機します..." . PHP_EOL;
17
18    // PHPのusleep()関数はマイクロ秒単位で時間を指定します。
19    // 1ミリ秒 = 1000マイクロ秒 のため、ミリ秒を1000倍して渡します。
20    usleep($milliseconds * 1000);
21
22    // 終了時刻とメッセージを表示
23    $endTime = microtime(true);
24    echo "処理を再開します。" . PHP_EOL;
25    echo "現在時刻: " . date('H:i:s') . substr((string)$endTime, 10) . PHP_EOL;
26
27    // 実際に経過した時間を計算して表示
28    $elapsedTime = ($endTime - $startTime) * 1000;
29    echo "実際の経過時間: " . round($elapsedTime) . "ミリ秒" . PHP_EOL;
30}
31
32// --- 関数の実行例 ---
33
34// 1500ミリ秒（1.5秒）待機させる
35sleepMilliseconds(1500);
36
37?>

このサンプルコードは、PHPプログラムの実行をミリ秒単位で一時的に停止させる方法を示しています。sleepMillisecondsという独自の関数を定義し、その中でPHPに標準で組み込まれているusleep()関数を利用しています。

usleep()関数は、プログラムの実行をマイクロ秒単位で停止させる機能を持っています。1ミリ秒は1000マイクロ秒に相当するため、このコードでは引数で受け取ったミリ秒の値に1000を掛けてusleep()関数に渡すことで、ミリ秒単位での待機を実現しています。

このsleepMilliseconds関数は、引数として待機させたい時間をミリ秒単位の整数で受け取ります。戻り値はvoidとなっており、これは関数が処理を実行するだけで、特定の値を返さないことを意味します。コード内では、microtime(true)を使って処理の開始時刻と終了時刻を記録し、実際にプログラムがどのくらいの時間停止していたかを計算して表示することで、関数の動作を分かりやすく確認できるようにしています。この手法により、秒単位よりも細かい時間での実行制御が可能になります。