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

Copy
1<?php
2
3/**
4 * PHPで指定されたミリ秒数だけ処理を一時停止するサンプル。
5 *
6 * プログラミング言語リファレンス情報としてDom\Attr::__sleepが提供されていますが、
7 * PHPのDom\Attrクラスには__sleepメソッドは標準では存在しません。
8 * ここでは、キーワード「php sleep ミリ 秒」に最も関連性の高い、
9 * スクリプトの実行をミリ秒単位で一時停止する方法を示します。
10 */
11function waitMilliseconds(int $milliseconds): void
12{
13    echo "処理を開始します。\n";
14    $startTime = microtime(true);
15
16    // ミリ秒をマイクロ秒に変換します。(1ミリ秒 = 1000マイクロ秒)
17    $microseconds = $milliseconds * 1000;
18    echo "{$milliseconds}ミリ秒（{$microseconds}マイクロ秒）待機します...\n";
19
20    // usleep()関数を使用して、指定されたマイクロ秒数だけスクリプトの実行を一時停止します。
21    usleep($microseconds);
22
23    $endTime = microtime(true);
24    // 経過時間をミリ秒単位で計算し、表示します。
25    $elapsedTime = round(($endTime - $startTime) * 1000, 2);
26    echo "待機が完了しました。経過時間: {$elapsedTime}ミリ秒\n";
27    echo "処理を続行します。\n";
28}
29
30// 例1: 250ミリ秒（0.25秒）待機
31waitMilliseconds(250);
32
33echo "\n--- 別の待機処理 ---\n\n";
34
35// 例2: 500ミリ秒（0.5秒）待機
36waitMilliseconds(500);

このPHPサンプルコードは、スクリプトの実行を指定されたミリ秒数だけ一時停止する方法を説明します。提供されたリファレンス情報にあるDom\Attr::__sleepは、PHPの標準クラスには通常存在しないメソッドですが、本サンプルコードは「php sleep ミリ 秒」というキーワードに基づき、一般的な一時停止処理の実装を示しています。

waitMilliseconds関数は、引数として渡されたミリ秒数だけ処理を一時停止します。引数$millisecondsには、一時停止したい時間を整数で指定します。この関数の戻り値はvoidであり、処理が完了しても特定の値を返しません。

関数内部では、PHPの標準関数であるusleep()が使用されています。usleep()はマイクロ秒（1ミリ秒の1000分の1）単位で動作するため、$millisecondsで指定されたミリ秒数は、まず1000倍されてマイクロ秒に変換されます。これにより、指定されたミリ秒数とほぼ同じ時間だけ、スクリプトの実行が中断されます。

実行すると、「処理を開始します。」と表示された後、指定時間分の待機が行われ、「待機が完了しました。」というメッセージと実際の経過時間がミリ秒単位で表示されます。この機能は、プログラムの処理速度を意図的に遅らせたり、一定間隔でタスクを実行したりする際に利用できます。