【PHP8.x】DateTime::getMicrosecond()メソッドの使い方

Copy
1<?php
2
3// DateTimeクラスは、日付と時刻の情報を扱うためのPHPの組み込みクラスです。
4// PHP 8 から、DateTimeオブジェクトが持つマイクロ秒部分を直接取得するgetMicrosecond()メソッドが追加されました。
5
6/**
7 * 現在の時刻のマイクロ秒部分を取得し、表示するサンプルコードです。
8 * システムエンジニアリングでは、高精度な時刻情報が必要な場面で役立ちます。
9 */
10
11// 1. 現在のDateTimeオブジェクトを作成します。
12//    これにより、現在の日付、時刻、そしてマイクロ秒の情報が取得されます。
13$now = new DateTime();
14
15// 2. getMicrosecond()メソッドを使用して、DateTimeオブジェクトからマイクロ秒部分を取得します。
16//    このメソッドは引数を取らず、0から999999までの整数を返します。
17$microseconds = $now->getMicrosecond();
18
19// 3. 取得したマイクロ秒の値をコンソールに出力します。
20echo "現在の時刻のマイクロ秒部分: " . $microseconds . "μs\n";
21
22// 4. 特定のマイクロ秒を持つDateTimeオブジェクトを作成し、getMicrosecond()でその値を確認する例です。
23//    DateTime::createFromFormat()を使って、指定したフォーマットで日付と時刻をパースします。
24//    'u' はマイクロ秒を表すフォーマット文字です。
25$specificTimeInput = '2023-10-27 15:30:00.123456';
26$format = 'Y-m-d H:i:s.u';
27$specificTime = DateTime::createFromFormat($format, $specificTimeInput);
28
29if ($specificTime instanceof DateTime) {
30    $specificMicroseconds = $specificTime->getMicrosecond();
31    echo "指定された時刻 '" . $specificTimeInput . "' のマイクロ秒部分: " . $specificMicroseconds . "μs\n";
32} else {
33    // 日付時刻のパースに失敗した場合のエラーハンドリング
34    echo "指定された日付時刻のフォーマットが不正なため、パースに失敗しました。\n";
35}
36

PHP 8で追加されたDateTimeクラスのgetMicrosecond()メソッドは、日付と時刻を扱うDateTimeオブジェクトが保持するマイクロ秒部分を整数で取得するために使用されます。このメソッドは引数を一切取らず、0から999999までの整数値を戻り値として返します。システムエンジニアリングでは、プログラムの実行時間をより詳細に計測したり、高精度なログを記録したりするなど、高精度な時刻情報が求められる場面で非常に役立ちます。

サンプルコードでは、まずnew DateTime()で現在のシステム時刻を持つDateTimeオブジェクトを作成し、$now->getMicrosecond()を呼び出すことで、現在の時刻のマイクロ秒部分を取得して表示しています。これにより、現在時刻のミリ秒よりも細かいマイクロ秒単位の情報を手軽に取得できることがわかります。

また、DateTime::createFromFormat()を使用して、特定のマイクロ秒（例: .123456）を含む文字列からDateTimeオブジェクトを生成し、そのオブジェクトに対してもgetMicrosecond()メソッドを適用して、正しくマイクロ秒が取得できることを示しています。このように、既存の時刻データからマイクロ秒を抽出したり、任意のマイクロ秒を設定した時刻情報を作成したりする際に、このメソッドが柔軟に利用できるため、より詳細な時間管理が可能となります。

Copy
1<?php
2
3/**
4 * DateTime::getMicrosecond() の使用例。
5 * 現在時刻からマイクロ秒部分を取得して表示します。
6 */
7function demonstrateGetMicrosecond(): void
8{
9    // 現在のDateTimeオブジェクトを作成
10    // PHP 8 では、デフォルトでマイクロ秒まで保持されます
11    $now = new DateTime();
12
13    // DateTime::getMicrosecond() メソッドを使用して、マイクロ秒部分を取得
14    $microseconds = $now->getMicrosecond();
15
16    // 結果を表示
17    echo "現在の時刻 (YYYY-MM-DD HH:MM:SS.uuuuuu): " . $now->format('Y-m-d H:i:s.u') . "\n";
18    echo "取得されたマイクロ秒: " . $microseconds . "マイクロ秒\n";
19
20    // 特定のマイクロ秒を持つDateTimeオブジェクトを作成して確認
21    $specificTime = DateTime::createFromFormat('Y-m-d H:i:s.u', '2023-10-27 10:30:15.123456');
22    if ($specificTime !== false) {
23        $specificMicroseconds = $specificTime->getMicrosecond();
24        echo "\n特定の時刻 (2023-10-27 10:30:15.123456) から取得されたマイクロ秒: " . $specificMicroseconds . "マイクロ秒\n";
25    }
26}
27
28// 関数を実行
29demonstrateGetMicrosecond();
30
31?>

PHPのDateTime::getMicrosecond()メソッドは、日付や時刻を扱うDateTimeオブジェクトから、時間の最小単位である「マイクロ秒」の部分を整数値として取得する際に利用されます。マイクロ秒は1秒の100万分の1を表す単位です。

サンプルコードでは、最初にnew DateTime()を使って現在時刻のDateTimeオブジェクトを作成しています。PHP 8以降では、このオブジェクトはデフォルトでマイクロ秒まで保持する高精度な時刻情報を持っています。

次に、作成した$nowオブジェクトに対してgetMicrosecond()メソッドを呼び出すことで、現在の時刻が持つマイクロ秒部分を取得しています。このメソッドは引数を一切必要とせず、取得したマイクロ秒の値をint型（整数）で返します。例えば、時刻が「10:30:15.123456」であれば、「123456」という数値が戻り値となります。

また、サンプルコードの後半では、DateTime::createFromFormat()を用いて意図的にマイクロ秒を指定した日時を作成し、そこからgetMicrosecond()で正確にマイクロ秒が取得できることを示しています。この機能は、システムのログ記録、パフォーマンス測定、イベントの発生時刻の厳密な管理など、時間の精度が求められるさまざまな場面で非常に有用です。