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

Copy
1<?php
2
3/**
4 * プログラムの実行を指定された時間（0.5秒）だけ一時停止するサンプルコードです。
5 * PHPの usleep() 関数は、マイクロ秒単位でプログラムの実行を一時停止します。
6 * 1秒は1,000,000マイクロ秒に相当します。
7 * 0.5秒は500,000マイクロ秒です。
8 */
9function demonstrateSleepForHalfSecond(): void
10{
11    echo "処理を開始します。\n";
12
13    // プログラムの実行を0.5秒間一時停止します (500,000マイクロ秒)
14    usleep(500000);
15
16    echo "0.5秒後に処理を再開しました。\n";
17}
18
19// 関数を実行します
20demonstrateSleepForHalfSecond();
21

このサンプルコードは、PHPプログラムの実行を一時的に停止する方法を実演しています。具体的にはusleep()関数を使用し、指定された時間（0.5秒）だけ処理を中断しています。usleep()関数は引数として一時停止したい時間をマイクロ秒単位で受け取ります。1秒は1,000,000マイクロ秒に相当するため、0.5秒間の一時停止には500,000マイクロ秒を指定します。この関数は、成功した場合はtrue、失敗した場合はfalseを返しますが、通常は戻り値を確認することなく、一時停止が完了するのを待って次の処理へ進みます。

提供されたリファレンス情報にあるDom\XMLDocument::__sleepメソッドは、このusleep()関数とは機能が異なりますのでご注意ください。__sleepメソッドはPHPの特殊メソッドの一つで、オブジェクトがシリアライズ（直列化）される際に呼び出されます。このメソッドは引数を持たず、オブジェクトのどのプロパティをシリアライズの対象とするかを、プロパティ名の文字列配列として返す役割があります。例えば、特定のプロパティを保存したくない場合などに使用されます。したがって、サンプルコードの目的であるプログラムの一時停止とは全く別の用途で使われるメソッドです。

Copy
1<?php
2
3/**
4 * 指定されたミリ秒だけプログラムの実行を一時停止します。
5 *
6 * PHPの標準関数 sleep() は秒単位でしか指定できませんが、
7 * usleep() を使うことで、より細かいマイクロ秒単位での待機が可能です。
8 * この関数は、ミリ秒をマイクロ秒に変換してusleep()を呼び出します。
9 *
10 * @param int $milliseconds 待機する時間（ミリ秒単位）。
11 * @return void
12 */
13function wait(int $milliseconds): void
14{
15    // 1ミリ秒は1000マイクロ秒です。
16    $microseconds = $milliseconds * 1000;
17
18    // usleep()はマイクロ秒単位でプログラムの実行を停止します。
19    usleep($microseconds);
20}
21
22// --- これより下は、関数の使用例です ---
23
24// 現在の時刻を取得してフォーマットする関数
25function getCurrentTime(): string
26{
27    // date()だけだと秒未満が表現できないため、microtime()と組み合わせて表示します。
28    $microtime = microtime(true);
29    return date('H:i:s', (int)$microtime) . '.' . sprintf('%03d', ($microtime - floor($microtime)) * 1000);
30}
31
32echo '処理を開始します。' . PHP_EOL;
33echo '現在時刻: ' . getCurrentTime() . PHP_EOL;
34
35// 500ミリ秒 (0.5秒) 待機します。
36$waitMilliseconds = 500;
37echo $waitMilliseconds . 'ミリ秒待機します...' . PHP_EOL;
38
39wait($waitMilliseconds);
40
41echo '処理を再開しました。' . PHP_EOL;
42echo '現在時刻: ' . getCurrentTime() . PHP_EOL;
43

このPHPサンプルコードは、プログラムの実行を指定したミリ秒単位で一時停止する独自の関数を定義し、その使用方法を示しています。

PHPに標準で備わっているsleep()関数は秒単位でしか待機時間を指定できません。しかし、このコードで定義されているwait()関数を使えば、より短いミリ秒単位での待機が可能になります。

wait()関数は、引数として待機させたい時間をミリ秒単位の整数 $milliseconds で受け取ります。この関数は特定の値を返さないため、戻り値の型は void となっています。

関数の内部では、マイクロ秒（100万分の1秒）単位で待機できるusleep()関数が使われています。引数で受け取ったミリ秒の値に1000を掛けてマイクロ秒に変換し、その値をusleep()関数に渡すことで、ミリ秒単位での正確な待機処理を実現しています。

後半の実行例では、wait(500)と記述することで、プログラムの実行を500ミリ秒（0.5秒）間停止させています。処理の開始時刻と再開時刻をコンソールに出力することで、指定した時間だけ正しく待機できていることを確認できます。