【PHP8.x】DateTimeImmutable::RFC3339定数の使い方

Copy
1<?php
2
3// DateTimeImmutable::RFC3339 は、RFC3339 形式の日付時刻を表す定数です。
4// DateTimeImmutable::RFC3339_EXTENDED は、RFC3339 拡張形式の日付時刻を表す定数です。
5
6// 現在の日時を RFC3339 拡張形式で取得する例
7$date = new DateTimeImmutable();
8$rfc3339Extended = $date->format(DateTimeImmutable::RFC3339_EXTENDED);
9
10// 結果を出力
11echo "RFC3339 Extended フォーマット: " . $rfc3339Extended . PHP_EOL;
12
13?>

このサンプルコードは、PHPで現在の日時を「RFC3339 拡張形式」という世界標準の書式で、かつ高精度な文字列として取得する方法を示しています。

まず new DateTimeImmutable() を使い、現在の日時情報を持つ変更不可能なオブジェクトを生成します。DateTimeImmutable クラスは、一度作成するとその日時を変更できないため、安全に日時データを扱うことができます。

次に、生成した日時オブジェクトの format() メソッドを呼び出します。このメソッドは、引数で指定された書式に従って日時を文字列に変換し、その結果を戻り値として返します。

ここで引数として指定している DateTimeImmutable::RFC3339_EXTENDED は、PHPにあらかじめ定義されている定数です。これは「年-月-日T時:分:秒.マイクロ秒+タイムゾーン」という、マイクロ秒（100万分の1秒）まで含む非常に詳細な書式を表します。似た定数に DateTimeImmutable::RFC3339 がありますが、こちらは秒までの形式です。

最後に、format() メソッドから返された文字列を出力しています。この高精度な日時形式は、APIでのデータ交換や、システムの詳細なログを記録する際などに非常に役立ちます。

Copy
1<?php
2
3/**
4 * 現在の日時をRFC3339形式で取得し、表示するサンプル。
5 *
6 * この関数は、DateTimeImmutable::RFC3339 定数を利用して、
7 * 現在の日時オブジェクトをRFC3339形式の文字列にフォーマットする方法を示します。
8 * RFC3339形式は、WebサービスやAPIなどで日付と時刻を標準的に表現する際によく使用されます。
9 */
10function displayCurrentDateTimeInRfc3339Format(): void
11{
12    // 現在の日時を表すDateTimeImmutableオブジェクトを生成します。
13    // DateTimeImmutableは、一度作成された日時情報を変更できない「不変」なオブジェクトです。
14    $now = new DateTimeImmutable();
15
16    // DateTimeImmutable::RFC3339定数を使って、
17    // $nowオブジェクトをRFC3339形式（例: "2023-10-27T10:00:00+09:00"）の文字列にフォーマットします。
18    // この定数は内部的に特定のフォーマット文字列（例: "Y-m-d\TH:i:sP"）を保持しています。
19    $rfc3339String = $now->format(DateTimeImmutable::RFC3339);
20
21    // フォーマットされた日時文字列を出力します。
22    echo "現在のRFC3339形式の日時: " . $rfc3339String . PHP_EOL;
23}
24
25// 上記の関数を実行し、結果を表示します。
26displayCurrentDateTimeInRfc3339Format();

このサンプルコードは、PHP 8で現在の日時を「RFC3339」という国際標準の形式で取得し、表示する方法を示しています。

まず、new DateTimeImmutable()として、現在の日時を表現するオブジェクトを作成します。DateTimeImmutableは、一度作成されるとその日時情報が変更できない「不変」なオブジェクトであり、安全に日時を扱いたい場合によく利用されます。

次に、この$nowオブジェクトのformat()メソッドを呼び出しています。このメソッドは、日時オブジェクトを特定の形式の文字列に変換するために使用されます。format()メソッドの引数には、変換したい形式を指定するための文字列または定数を渡します。

ここで登場するのが、DateTimeImmutable::RFC3339定数です。この定数自体は引数を持ちませんが、RFC3339形式（例: "2023-10-27T10:00:00+09:00"）に対応する特定のフォーマット文字列を内部的に保持しています。この定数をformat()メソッドに渡すことで、$nowオブジェクトが持つ現在の日時情報がRFC3339形式の文字列に変換され、その文字列がformat()メソッドの戻り値として返されます。

RFC3339形式は、WebサービスやAPIなどで日付と時刻を交換する際の標準的な表現方法として広く使われており、システム間で日時情報を正確にやり取りする際に非常に役立ちます。最後に、変換された日時文字列をecho文で画面に出力しています。

Copy
1<?php
2
3/**
4 * 現在の日時を RFC3339 フォーマットの文字列として取得します。
5 *
6 * RFC3339 フォーマットは、インターネット標準のタイムスタンプ形式の一つで、
7 * ISO 8601 のサブセットです。主にAPIのデータ交換などで利用されます。
8 *
9 * @return string RFC3339 形式の日時文字列 (例: "2023-10-27T10:30:00+09:00")
10 */
11function getCurrentDateTimeRfc3339(): string
12{
13    // 現在の日時を表す DateTimeImmutable オブジェクトを作成します。
14    // DateTimeImmutable は変更不可な日付/時刻オブジェクトです。
15    $dateTime = new DateTimeImmutable();
16
17    // DateTimeImmutable::RFC3339 定数を使用して、
18    // 日時を指定されたRFC3339フォーマットに変換します。
19    // この定数は、"Y-m-d\TH:i:sP" というフォーマット文字列を表します。
20    return $dateTime->format(DateTimeImmutable::RFC3339);
21}
22
23// 関数を実行し、結果を出力します。
24// 例: "2023-10-27T10:30:00+09:00" のような形式が表示されます。
25echo getCurrentDateTimeRfc3339();
26
27?>

このPHPコードは、現在の日時を「RFC3339」という特定の形式の文字列として取得する方法を示しています。RFC3339フォーマットは、インターネット上で日時情報を標準的に扱うための形式の一つで、API連携などでタイムスタンプを交換する際によく利用されます。例えば「2023-10-27T10:30:00+09:00」のような形式です。

コードではまず、現在の日時を表すDateTimeImmutableオブジェクトを作成しています。DateTimeImmutableは、一度作成すると内容が変更されない（変更不可な）日付・時刻オブジェクトであり、安全に日時を扱いたい場合に適しています。

次に、このDateTimeImmutableオブジェクトのformat()メソッドを呼び出し、引数にDateTimeImmutable::RFC3339定数を指定しています。DateTimeImmutable::RFC3339は、RFC3339形式に合わせた日時フォーマット文字列（例: "Y-m-d\TH:i:sP"）をあらかじめ定義した定数です。これにより、手動でフォーマット文字列を記述する手間なく、簡単にRFC3339形式へ変換できます。

getCurrentDateTimeRfc3339()関数は引数なしで、RFC3339形式の現在日時文字列を戻り値として返します。このコードを実行すると、現在のシステム時刻がRFC3339形式で出力されます。