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

getOffsetメソッドは、DateTimeImmutableオブジェクトが保持するタイムゾーンのUTC（協定世界時）からのオフセット値を秒単位で取得するメソッドです。このメソッドはDateTimeImmutableクラスのインスタンスに対して呼び出すことで、そのオブジェクトが表す日時がUTCからどれだけずれているかを数値で知ることができます。

例えば、日本時間（JST）を表すDateTimeImmutableオブジェクトに対してgetOffsetメソッドを呼び出すと、32400という値が返されます。これは、JSTがUTCよりも9時間（9 * 60 * 60 = 32400秒）進んでいることを示します。

このメソッドは、異なるタイムゾーンの日時情報を扱う際に、それらの日時をUTCに変換したり、逆にUTCから特定のタイムゾーンに変換したりする上で非常に重要です。システム内で日時データを一元的に管理し、タイムゾーンを考慮した処理を行う場合に、getOffsetメソッドは不可欠な役割を果たします。特に、国際的なシステムや、複数のタイムゾーンにまたがるサービスを開発する際には、このメソッドの理解と活用が求められます。

getOffsetメソッドの戻り値は整数値であり、正の値はUTCよりも時間が進んでいることを、負の値はUTCよりも時間が遅れていることを示します。0はUTC自体を表します。

Copy
1public DateTimeZone|false getOffset(): int

引数なし

引数はありません

DateTimeImmutable::getOffset() は int を返すので、

int

DateTimeImmutable::getOffset() は、タイムゾーンのオフセットを秒単位で表す整数値を返します。