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

Copy
1<?php
2
3/**
4 * Unixタイムスタンプを使用してDateTimeImmutableオブジェクトの時刻を設定するサンプル。
5 *
6 * DateTimeImmutable::setTimestamp() メソッドは、既存のDateTimeImmutableオブジェクトの
7 * 日付と時刻を、指定されたUnixタイムスタンプに変更します。
8 * Unixタイムスタンプは、1970年1月1日 00:00:00 UTCからの秒数を表す整数です。
9 */
10function exampleSetTimestamp(): void
11{
12    // 現在のタイムスタンプを持つDateTimeImmutableオブジェクトを作成します。
13    // このオブジェクトの時刻を変更するのではなく、新しいDateTimeImmutableオブジェクトが返されます。
14    $currentDateTime = new DateTimeImmutable();
15    echo "初期の時刻: " . $currentDateTime->format('Y-m-d H:i:s') . "\n";
16
17    // 設定したいUnixタイムスタンプを定義します。
18    // 例: 2023年1月1日 00:00:00 UTC のタイムスタンプ
19    $unixTimestamp = 1672531200; 
20    echo "設定するUnixタイムスタンプ: " . $unixTimestamp . " (2023年1月1日 00:00:00 UTC)\n";
21
22    // setTimestampメソッドを使用して、新しいDateTimeImmutableオブジェクトを取得します。
23    // このメソッドは元の$currentDateTimeオブジェクトを変更しません。
24    $newDateTime = $currentDateTime->setTimestamp($unixTimestamp);
25
26    // setTimestampはDateTimeImmutableオブジェクト、または失敗した場合はfalseを返します。
27    if ($newDateTime instanceof DateTimeImmutable) {
28        echo "setTimestampで設定後の時刻: " . $newDateTime->format('Y-m-d H:i:s') . "\n";
29    } else {
30        echo "エラー: タイムスタンプの設定に失敗しました。\n";
31    }
32
33    // 元のオブジェクトは変更されていないことを確認できます。
34    echo "元のオブジェクトの時刻 (変更なし): " . $currentDateTime->format('Y-m-d H:i:s') . "\n";
35}
36
37// 関数を実行します。
38exampleSetTimestamp();
39

DateTimeImmutable::setTimestamp()は、DateTimeImmutableオブジェクトの時刻を指定したUnixタイムスタンプに基づいて設定するメソッドです。このメソッドは、新しいDateTimeImmutableオブジェクトを返し、元のオブジェクトは変更しません。引数$timestampには、設定したいUnixタイムスタンプ（1970年1月1日 00:00:00 UTCからの秒数）を整数で指定します。

サンプルコードでは、まずDateTimeImmutableオブジェクトを生成し、現在の時刻を表示します。次に、設定したいUnixタイムスタンプを変数に格納し、setTimestamp()メソッドを使って新しいDateTimeImmutableオブジェクトを作成します。setTimestamp()メソッドは、成功した場合は新しいDateTimeImmutableオブジェクトを、失敗した場合はfalseを返します。返り値がDateTimeImmutableオブジェクトであるか確認し、成功した場合のみ新しい時刻を表示します。最後に、元のオブジェクトの時刻が変わっていないことを確認します。この例では、setTimestamp()が新しいインスタンスを生成し、元のインスタンスは不変であることを示しています。