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

setMicrosecondメソッドは、DateTimeクラスのインスタンスが表す日付と時刻のマイクロ秒の値を設定するメソッドです。

DateTimeオブジェクトは、日付と時刻を管理するための標準的なクラスで、通常は秒単位までの精度で扱われます。しかし、このsetMicrosecondメソッドを利用することで、秒よりもさらに細かい、100万分の1秒単位であるマイクロ秒（μs）を指定して、時刻情報を精密に操作することが可能になります。

このメソッドは、0から999999までの整数値一つを引数として受け取ります。この引数で指定した値が、DateTimeオブジェクトが持つ時刻情報のマイクロ秒部分に設定されます。例えば、500000を指定すると、その時刻は現在の秒に加えて500ミリ秒（0.5秒）を持つことになります。これにより、非常に正確なタイムスタンプを作成したり、既存の時刻の精度を高めたりできます。

setMicrosecondメソッドは、設定が成功した場合にDateTimeオブジェクト自身を返します。そのため、このメソッドの呼び出し後に続けてDateTimeオブジェクトの他のメソッドを呼び出す、いわゆるメソッドチェーンを使用でき、コードの記述をより簡潔に行うことが可能です。

高精度な時刻情報を扱う必要があるシステム、例えば詳細なログ記録、パフォーマンスの測定、あるいは金融取引のようにミリ秒以下の精度が求められる場面で、このメソッドは非常に有用です。PHP 8以降で導入された機能ですので、利用する際はPHPのバージョンに注意してください。

Copy
1<?php
2$date = new DateTime('2023-01-01 10:30:00.000000');
3$date->setMicrosecond(500000);
4echo $date->format('Y-m-d H:i:s.u');
5?>

int $microsecond

• int $microsecond: 0から999999の範囲でマイクロ秒を指定する整数

DateTime

このメソッドは、DateTimeオブジェクト自身を返します。これにより、メソッドチェーンによる連続した操作が可能になります。