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

Copy
1<?php
2
3/**
4 * UNIXタイムスタンプからDateTimeImmutableオブジェクトを生成し、その結果を表示する関数。
5 *
6 * @param int|float $timestamp UNIXタイムスタンプ（秒）
7 * @return void
8 */
9function createDateTimeFromTimestampAndDisplay(int|float $timestamp): void
10{
11    echo "--- DateTimeImmutable::createFromTimestamp ---" . PHP_EOL;
12    echo "入力されたUNIXタイムスタンプ: " . $timestamp . PHP_EOL;
13
14    try {
15        // DateTimeImmutable::createFromTimestamp() を使用して、
16        // 指定されたUNIXタイムスタンプから不変な日付/時刻オブジェクトを作成します。
17        // これは、特定の時点を正確に表現したい場合に役立ちます。
18        $dateTime = DateTimeImmutable::createFromTimestamp($timestamp);
19
20        echo "生成された日付と時刻 (UTC): " . $dateTime->format('Y-m-d H:i:s (e)') . PHP_EOL;
21        // タイムゾーンを指定して表示することも可能です (例: Asia/Tokyo)
22        $dateTime->setTimezone(new DateTimeZone('Asia/Tokyo'));
23        echo "生成された日付と時刻 (JST): " . $dateTime->format('Y-m-d H:i:s (e)') . PHP_EOL;
24
25    } catch (Exception $e) {
26        echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
27    }
28    echo PHP_EOL;
29}
30
31// 現在のUNIXタイムスタンプを取得して使用する例
32$currentTimestamp = time();
33createDateTimeFromTimestampAndDisplay($currentTimestamp);
34
35// 特定のUNIXタイムスタンプ（例: 2023年10月27日 10:30:00 UTC）を使用する例
36$specificTimestamp = 1698393000;
37createDateTimeFromTimestampAndDisplay($specificTimestamp);
38
39// 浮動小数点数のタイムスタンプ（ミリ秒やマイクロ秒を含む場合）を使用する例
40// PHPのtime()は整数を返すため、例としてfloatで指定
41$floatTimestamp = 1698393000.500; // 0.5秒後
42createDateTimeFromTimestampAndDisplay($floatTimestamp);
43
44?>

PHP 8のDateTimeImmutable::createFromTimestampメソッドは、指定されたUNIXタイムスタンプから、不変（イミュータブル）な日付と時刻を表すDateTimeImmutableオブジェクトを生成する際に使用します。UNIXタイムスタンプとは、1970年1月1日0時0分0秒（UTC）からの経過秒数を整数または浮動小数点数で表したもので、引数$timestampとしてこの値を受け取ります。このメソッドが返すDateTimeImmutableオブジェクトは、一度生成されると内容が変更されない特性を持つため、日付や時刻の予期せぬ変更を防ぎ、より堅牢なコード作成に役立ちます。

サンプルコードでは、time()関数で取得した現在のUNIXタイムスタンプや、特定の瞬間を表す秒数、さらに小数点以下の秒数を含むタイムスタンプの例を示しています。createFromTimestampメソッドで生成されたオブジェクトは、デフォルトでUTC（協定世界時）のタイムゾーンを持ちますが、setTimezoneメソッドを利用することで、例えば日本の標準時（JST）など、任意のタイムゾーンに変換して表示することが可能です。これにより、国際的なシステム開発で発生するタイムゾーンの違いを適切に処理できます。

Copy
1<?php
2
3/**
4 * タイムスタンプからDateTimeImmutableオブジェクトを生成し、表示する例。
5 *
6 * DateTimeImmutable::createFromTimestamp() は、与えられたUNIXタイムスタンプを元に
7 * 新しいDateTimeImmutableオブジェクトを作成します。
8 * UNIXタイムスタンプは、1970年1月1日 00:00:00 UTCからの秒数です。
9 */
10
11// 現在のUNIXタイムスタンプを取得
12$currentTimestamp = time();
13
14// 現在のタイムスタンプからDateTimeImmutableオブジェクトを生成
15// デフォルトではUTCとして扱われます
16$dateTimeImmutableFromCurrentTimestamp = DateTimeImmutable::createFromTimestamp($currentTimestamp);
17
18echo "現在のタイムスタンプ: " . $currentTimestamp . "\n";
19echo "生成された日付時刻 (現在): " . $dateTimeImmutableFromCurrentTimestamp->format('Y-m-d H:i:s P') . "\n\n";
20
21// 特定の日時のUNIXタイムスタンプ（例: 2023年1月1日 12:30:45 UTC）
22$specificTimestamp = 1672576245;
23
24// 特定のタイムスタンプからDateTimeImmutableオブジェクトを生成
25$dateTimeImmutableFromSpecificTimestamp = DateTimeImmutable::createFromTimestamp($specificTimestamp);
26
27echo "特定のタイムスタンプ: " . $specificTimestamp . "\n";
28echo "生成された日付時刻 (特定): " . $dateTimeImmutableFromSpecificTimestamp->format('Y-m-d H:i:s P') . "\n";
29
30?>

DateTimeImmutable::createFromTimestampメソッドは、UNIXタイムスタンプと呼ばれる数値情報から、PHPで日付や時刻を扱うためのDateTimeImmutableオブジェクトを生成する際に使用されます。UNIXタイムスタンプとは、1970年1月1日 00:00:00 協定世界時（UTC）からの経過秒数をint型またはfloat型の数値で表したもので、日付時刻情報をコンピュータが扱いやすい単一の数値として表現する国際標準の一つです。

このメソッドの引数には、生成したい日付時刻を表すUNIXタイムスタンプを渡します。戻り値として返されるDateTimeImmutableオブジェクトは、一度作成されると内容が変更できない（不変な）性質を持つため、意図しないデータ変更を防ぐことができます。

提供されたサンプルコードでは、まずPHPのtime()関数を使って現在のUNIXタイムスタンプを取得し、それをcreateFromTimestampメソッドに渡して現在のDateTimeImmutableオブジェクトを生成しています。生成されたオブジェクトは、format('Y-m-d H:i:s P')という書式指定で、年、月、日、時、分、秒、そしてタイムゾーンオフセットを含む人間が読みやすい形式に整形して表示されます。

次に、特定の時点を表すUNIXタイムスタンプ（例えば1672576245）を直接指定し、同様にDateTimeImmutableオブジェクトを生成して表示する例を示しています。これにより、過去や未来の任意のUNIXタイムスタンプから正確な日付時刻オブジェクトを簡単に作成し、その後の日付計算や表示、他のシステムとの連携などに利用できることを理解できます。このメソッドは、データベースにUNIXタイムスタンプ形式で保存された日時データをPHPで扱う際に非常に便利です。