【PHP8.x】DOMNotation::__sleep()メソッドの使い方
__sleepメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
__sleepメソッドは、PHPのDOMNotationクラスに属し、オブジェクトをシリアライズする際に実行される特別なメソッドです。このメソッドはマジックメソッドの一つとして、serialize()関数がオブジェクトに対して呼び出されたときに自動的に実行されます。
DOMNotationクラスは、XMLドキュメント型定義（DTD）における記法（NOTATION）に関する情報を取り扱うクラスです。この__sleepメソッドの主な役割は、DOMNotationオブジェクトがシリアライズされる際に、どのプロパティを保存すべきかを指定することにあります。
オブジェクトをシリアライズするとは、オブジェクトの状態をバイト列に変換し、ファイルへの保存やネットワーク経由での転送を可能にする処理のことです。このメソッドは、シリアライズすべきプロパティの名前を文字列として含む配列を返す必要があります。この配列に含まれないプロパティはシリアライズ処理から除外されるため、復元される際にはデフォルト値となります。
__sleepメソッドを利用することで、ディスク容量の節約やセキュリティ上の理由で一部のプロパティを保存したくない場合など、オブジェクトの必要な情報のみを効率的に保存・復元できるようになります。これにより、システムのパフォーマンスやセキュリティの向上に貢献します。
構文(syntax)
1public function __sleep(): array 2{ 3 return []; 4}
引数(parameters)
引数なし
引数はありません
戻り値(return)
array
DOMNotationクラスの__sleepメソッドは、オブジェクトのシリアライズ（保存や転送のためにオブジェクトをバイト列に変換すること）に使用されるプロパティ名を配列で返します。
サンプルコード
PHPで0.5秒待機する処理
1<?php 2 3/** 4 * 指定した秒数だけプログラムの実行を一時停止します。 5 * 6 * このサンプルでは、0.5秒間処理を停止する方法を示します。 7 * 小数点以下の秒数を扱うために `usleep()` 関数を使用します。 8 * 9 * @param float $seconds 停止する秒数（例: 0.5） 10 */ 11function waitSeconds(float $seconds): void 12{ 13 // 処理開始前のタイムスタンプと時刻を表示 14 $startTime = microtime(true); 15 echo "処理開始: " . date('Y-m-d H:i:s') . substr((string)$startTime, 10, 4) . PHP_EOL; 16 17 // 指定された秒数だけプログラムの実行を停止します。 18 // usleepはマイクロ秒（100万分の1秒）を引数に取るため、秒数を変換します。 19 $microseconds = (int)($seconds * 1_000_000); 20 echo "{$seconds}秒間、待機します..." . PHP_EOL; 21 usleep($microseconds); 22 23 // 処理再開後のタイムスタンプと時刻を表示 24 $endTime = microtime(true); 25 echo "処理再開: " . date('Y-m-d H:i:s') . substr((string)$endTime, 10, 4) . PHP_EOL; 26 27 // 実際の経過時間を計算して表示 28 $elapsedTime = round($endTime - $startTime, 4); 29 echo "経過時間: {$elapsedTime}秒" . PHP_EOL; 30} 31 32// 関数を呼び出し、0.5秒間処理を停止します。 33waitSeconds(0.5); 34 35?>
このPHPサンプルコードは、プログラムの実行を指定した秒数だけ一時停止する方法を示しています。特に、0.5秒のような1秒未満の時間を扱うために usleep() 関数を利用している点が特徴です。
PHPにはプログラムを停止させる関数として sleep() もありますが、これは秒単位の整数しか指定できません。一方、サンプルコードで使われている usleep() 関数は、マイクロ秒（100万分の1秒）という、より細かい単位で時間を指定できます。そのため、0.5秒を指定したい場合は、0.5 * 1_000_000 のように計算して usleep() 関数に渡す必要があります。
コード内の waitSeconds 関数は、引数 $seconds で停止したい秒数を小数で受け取ります。この関数は特定の値を返さないため、戻り値の型は void となっています。関数内では、処理の開始時刻と再開時刻を表示することで、実際に指定した時間だけプログラムが停止したことを確認できるようになっています。この方法は、APIへの連続アクセスを避けるためや、処理のタイミングを調整する際などに役立ちます。
このコードで使われている usleep() 関数は、引数にマイクロ秒（100万分の1秒）単位の整数を指定します。0.5秒のような小数で待機させたい場合、サンプルコードのように1,000,000を掛けて整数に変換する必要がある点に注意してください。秒単位の整数しか扱えない sleep() 関数とは用途が異なります。また、OSの状況によっては指定した時間きっかりに処理が再開されるとは限らず、少し長く停止することがあります。Webサーバー上で安易に使用すると、その間リクエストの処理が完全に停止し、システムの応答性能に影響を与える可能性があるため、利用は慎重に検討する必要があります。
PHPでミリ秒スリープする
1<?php 2 3/** 4 * 指定されたミリ秒だけプログラムの実行を一時停止します。 5 * 6 * PHPの標準関数 usleep() はマイクロ秒（1/1,000,000秒）単位で時間を指定するため、 7 * ミリ秒（1/1,000秒）を1000倍して渡します。 8 * 9 * @param int $milliseconds 停止する時間（ミリ秒） 10 */ 11function sleepForMilliseconds(int $milliseconds): void 12{ 13 // 処理開始前の時間を記録 14 $startTime = microtime(true); 15 echo "処理を開始します。現在時刻: " . date('H:i:s') . PHP_EOL; 16 17 // 指定されたミリ秒だけスリープ 18 echo "{$milliseconds}ミリ秒だけスリープします..." . PHP_EOL; 19 usleep($milliseconds * 1000); 20 21 // 処理終了後の時間を記録 22 $endTime = microtime(true); 23 echo "スリープが完了しました。現在時刻: " . date('H:i:s') . PHP_EOL; 24 25 // 実際の経過時間を計算して表示 26 $elapsedTime = ($endTime - $startTime) * 1000; 27 echo "実際の経過時間: " . round($elapsedTime) . "ミリ秒" . PHP_EOL; 28} 29 30// 1500ミリ秒（1.5秒）スリープさせる例 31sleepForMilliseconds(1500); 32 33?>
このPHPサンプルコードは、プログラムの実行を指定したミリ秒（1000分の1秒）単位で一時停止する方法を示しています。PHPには、秒単位でスリープするsleep()関数と、マイクロ秒（100万分の1秒）単位でスリープするusleep()関数が標準で用意されています。このコードでは、ミリ秒単位での柔軟な時間制御を実現するためにusleep()関数を利用しています。
sleepForMillisecondsという独自の関数を定義し、引数$millisecondsで停止したい時間をミリ秒で受け取ります。この関数は戻り値を持ちません。関数内部では、引数で受け取ったミリ秒の値に1000を掛けてマイクロ秒に変換し、その結果をusleep()関数に渡すことで、指定された時間だけプログラムの実行を停止します。
コードの実行例では、処理の開始時刻と終了時刻を表示し、実際に経過した時間を確認できるようにしています。最後の行でsleepForMilliseconds(1500)と呼び出すことで、プログラムの実行が約1500ミリ秒（1.5秒）間停止することを確認できます。
指定された DOMNotation::__sleep は、オブジェクトを保存（シリアライズ）する際に呼ばれる特殊なメソッドであり、プログラムの実行を一時停止させる機能ではありません。サンプルコードで実行を一時停止しているのは usleep() 関数です。この関数の引数はマイクロ秒（100万分の1秒）単位のため、ミリ秒で指定したい場合は1000倍する必要があります。秒単位で停止する sleep() 関数と間違えないよう注意してください。また、usleep() はプログラムの実行を完全に止めてしまうため、Webサイトなどで安易に長い時間使用すると、応答が遅れる原因となります。APIの連続アクセスを避けるなど、短い時間での利用に留めるのが安全です。