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

Copy
1<?php
2
3/**
4 * DateTimeImmutable::getTimestamp() メソッドを使用して、
5 * 現在のUnixタイムスタンプ（秒単位）を取得し、それをミリ秒に変換して表示します。
6 *
7 * DateTimeImmutable::getTimestamp() は、常に秒単位の整数値を返します。
8 * ミリ秒単位の値が必要な場合は、取得した秒単位のタイムスタンプに1000を掛けて計算します。
9 */
10function showTimestampConversion(): void
11{
12    // 現在のUTC時刻を表すDateTimeImmutableオブジェクトを作成します。
13    // 日付と時刻の操作には、DateTimeImmutableクラスの利用が推奨されます。
14    $now = new DateTimeImmutable('now', new DateTimeZone('UTC'));
15
16    // getTimestamp() メソッドを呼び出し、Unixタイムスタンプ（秒単位）を取得します。
17    // これは、1970年1月1日 00:00:00 UTC からの経過秒数を表す整数値です。
18    $timestampInSeconds = $now->getTimestamp();
19
20    // 秒単位のタイムスタンプをミリ秒に変換します。
21    // DateTimeImmutable::getTimestamp() はミリ秒を直接提供しないため、
22    // 1000を掛けて計算します。
23    $timestampInMilliseconds = $timestampInSeconds * 1000;
24
25    echo "現在のUTC時刻: " . $now->format('Y-m-d H:i:s') . " UTC" . PHP_EOL;
26    echo "Unixタイムスタンプ (秒単位): " . $timestampInSeconds . PHP_EOL;
27    echo "Unixタイムスタンプ (ミリ秒単位に変換): " . $timestampInMilliseconds . PHP_EOL;
28}
29
30// 関数を実行して結果を表示します。
31showTimestampConversion();
32
33?>

このPHPサンプルコードは、DateTimeImmutable::getTimestamp()メソッドを使って現在のUnixタイムスタンプを秒単位で取得し、さらにミリ秒に変換して表示する方法を説明しています。

まず、日付と時刻の操作には、オブジェクトが変更されないDateTimeImmutableクラスの利用が推奨されており、現在のUTC時刻を表すDateTimeImmutableオブジェクトを生成します。

次に、このオブジェクトに対してgetTimestamp()メソッドを呼び出します。このメソッドは引数を取らず、戻り値として整数型（int）の値を返します。この整数値は「Unixタイムスタンプ」と呼ばれ、1970年1月1日 00:00:00 UTC（協定世界時）からの経過秒数を表します。システム内で時間を比較したり記録したりする際によく利用されます。

getTimestamp()メソッドが返すのは秒単位のタイムスタンプであるため、ミリ秒単位の値が必要な場合は、取得した秒単位のタイムスタンプに1000を掛けて計算します。サンプルコードでは、この変換処理も示されており、現在のUTC時刻、秒単位のタイムスタンプ、そしてミリ秒単位に変換されたタイムスタンプがそれぞれ表示されます。これにより、プログラムで時刻情報を正確に扱うための基本的な手法を学ぶことができます。

Copy
1<?php
2
3/**
4 * DateTimeImmutable::getTimestamp() メソッドがタイムゾーンとどのように関連するかを示すサンプル。
5 * getTimestamp() は常にUTC基準のUnixタイムスタンプを返します。
6 */
7function demonstrateGetTimestampWithTimezone(): void
8{
9    // PHPのデフォルトタイムゾーンを設定（通常はphp.iniで設定しますが、ここでは一時的に設定）
10    // この設定は、DateTimeImmutableコンストラクタでタイムゾーンが明示されない場合に適用されます。
11    date_default_timezone_set('Europe/Berlin'); // 例: ベルリン時間 (UTC+2 または UTC+1)
12
13    echo "--- デフォルトタイムゾーン (Europe/Berlin) での操作 ---\n";
14
15    // 1. デフォルトタイムゾーンの現在時刻でDateTimeImmutableオブジェクトを作成
16    $nowBerlin = new DateTimeImmutable();
17    echo "現在時刻 (ベルリン): " . $nowBerlin->format('Y-m-d H:i:s P') . "\n";
18    // getTimestamp()は、この瞬間を表すUTCからの秒数を返します。
19    echo "UTCタイムスタンプ (ベルリン): " . $nowBerlin->getTimestamp() . "\n\n";
20
21    echo "--- 異なるタイムゾーン (Asia/Tokyo) での操作 ---\n";
22
23    // 2. 異なるタイムゾーンを指定してDateTimeImmutableオブジェクトを作成
24    $timeZoneTokyo = new DateTimeZone('Asia/Tokyo'); // 東京時間 (UTC+9)
25    $nowTokyo = new DateTimeImmutable('now', $timeZoneTokyo);
26    echo "現在時刻 (東京): " . $nowTokyo->format('Y-m-d H:i:s P') . "\n";
27    // 同じ「瞬間」を異なるタイムゾーンで取得した場合、UTCタイムスタンプは同じになります。
28    echo "UTCタイムスタンプ (東京): " . $nowTokyo->getTimestamp() . "\n\n";
29
30    echo "--- 既存オブジェクトのタイムゾーン変更 ---\n";
31
32    // 3. 既存のDateTimeImmutableオブジェクトのタイムゾーンを変更する
33    // これにより、DateTimeImmutableオブジェクトが表す「瞬間」は変わらず、表示される現地時刻が変わります。
34    $convertedToTokyo = $nowBerlin->setTimezone($timeZoneTokyo);
35    echo "ベルリンの時刻を東京タイムゾーンで表示: " . $convertedToTokyo->format('Y-m-d H:i:s P') . "\n";
36    // オブジェクトが表す「瞬間」は変わっていないため、getTimestamp()の結果も変わりません。
37    echo "UTCタイムスタンプ (タイムゾーン変換後): " . $convertedToTokyo->getTimestamp() . "\n\n";
38
39    echo "--- まとめ ---\n";
40    echo "getTimestamp() メソッドは、常にDateTimeImmutableオブジェクトが表す\n";
41    echo "「特定の瞬間」をUTCからの秒数（Unixタイムスタンプ）として返します。\n";
42    echo "タイムゾーンは、その「特定の瞬間」をどの現地時刻で表示するかを決定しますが、\n";
43    echo "UTCタイムスタンプそのものには影響を与えません。\n";
44}
45
46// 関数を実行して動作を確認
47demonstrateGetTimestampWithTimezone();

DateTimeImmutable::getTimestamp()は、PHPのDateTimeImmutableクラスが持つメソッドです。このメソッドは引数を受け取らず、戻り値として整数型（int）のUnixタイムスタンプを返します。

このメソッドの最も重要な役割は、DateTimeImmutableオブジェクトが表す「特定の瞬間」を、常にUTC（協定世界時）基準のUnixタイムスタンプとして取得することです。Unixタイムスタンプとは、1970年1月1日0時0分0秒UTCからの経過秒数を指します。

DateTimeImmutableオブジェクトは、内部的にタイムゾーン情報を持っていますが、これはその「瞬間」をどの地域の現地時刻で表示するかを決定するものです。getTimestamp()メソッドが返すUTCタイムスタンプは、このタイムゾーン設定に影響されません。たとえば、同じ「瞬間」をベルリン時間と東京時間でそれぞれ表すDateTimeImmutableオブジェクトを作成しても、両者のgetTimestamp()の戻り値は全く同じになります。これは、タイムゾーンが異なっても、オブジェクトが指し示す「絶対的な瞬間」は変わらないためです。この特性により、タイムゾーンを意識せずに時刻を比較したり、データを処理したりする際に非常に便利です。