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

Copy
1<?php
2
3/**
4 * 現在の日時をRFC 7231形式でフォーマットし、出力します。
5 *
6 * DateTimeImmutable::RFC7231 定数は、HTTPヘッダーなどで一般的に使用される日付形式
7 * "D, d M Y H:i:s T" を表す文字列です。
8 *
9 * この関数は、システムエンジニアがWebアプリケーションなどで日付を標準的な形式で
10 * 表現する必要がある場合の使い方を示しています。
11 */
12function displayRfc7231FormattedDateTime(): void
13{
14    // 現在の日時を表すDateTimeImmutableオブジェクトを作成します。
15    // DateTimeImmutableは、一度作成されると内容が変更されない（イミュータブルな）日付時刻オブジェクトです。
16    $currentDateTime = new DateTimeImmutable();
17
18    // DateTimeImmutable::RFC7231 定数を使用して、現在の日時をRFC 7231形式の文字列にフォーマットします。
19    $formattedDateString = $currentDateTime->format(DateTimeImmutable::RFC7231);
20
21    // フォーマットされた日付文字列を出力します。
22    echo "現在の日時 (RFC 7231形式): " . $formattedDateString . PHP_EOL;
23
24    // 参考: DateTimeImmutable::RFC7231 定数自体がどのような文字列を持っているかを確認することもできます。
25    // echo "RFC 7231フォーマット定数の値: " . DateTimeImmutable::RFC7231 . PHP_EOL;
26}
27
28// 関数を実行し、結果を表示します。
29displayRfc7231FormattedDateTime();

PHPのサンプルコードは、現在の日時をWebアプリケーションなどでよく使われるRFC 7231という形式で表示する方法を示しています。DateTimeImmutable::RFC7231は、DateTimeImmutableクラスが持つ特別な定数で、「D, d M Y H:i:s T」という日付フォーマットを表す文字列です。この定数自体は引数を取らず、常にこの固定の文字列を返します。

コードではまず、現在のシステム日時を表すDateTimeImmutableオブジェクトを作成します。DateTimeImmutableは一度作成されると内容が変わらない（イミュータブルな）日付時刻オブジェクトです。次に、このオブジェクトのformat()メソッドを使用し、引数としてDateTimeImmutable::RFC7231定数を渡します。これにより、現在の日時がRFC 7231形式の文字列に変換され、$formattedDateStringに格納されます。format()メソッドの戻り値は、指定された形式でフォーマットされた日付文字列です。最後に、このフォーマットされた日付文字列を画面に出力しています。

この定数を使うことで、HTTPヘッダーなどで標準的に要求される日付形式を簡単に実現でき、システムエンジニアがWebサービスの開発で日付情報を正確に扱う際に役立ちます。

Copy
1<?php
2
3/**
4 * 現在の時刻を RFC 7231 (HTTP-date) 形式でフォーマットして返します。
5 *
6 * RFC 7231 は、HTTP ヘッダーなどで使用される日付フォーマットを定義しており、
7 * タイムゾーンは GMT (UTC) である必要があります。
8 *
9 * @return string RFC 7231 形式でフォーマットされた日時文字列。例: "Tue, 15 Nov 1994 12:45:26 GMT"
10 */
11function getCurrentDateTimeRfc7231(): string
12{
13    // 現在の時刻を UTC タイムゾーンでDateTimeImmutableオブジェクトとして取得します。
14    // RFC 7231 の仕様では、時刻は GMT (UTC) で表現される必要があります。
15    $now = new DateTimeImmutable('now', new DateTimeZone('UTC'));
16
17    // DateTimeImmutable::RFC7231 定数を使用して、日付を RFC 7231 形式でフォーマットします。
18    // この定数は 'D, d M Y H:i:s T' というフォーマット文字列を表します。
19    return $now->format(DateTimeImmutable::RFC7231);
20}
21
22// 関数を実行し、フォーマットされた現在時刻を出力します。
23echo getCurrentDateTimeRfc7231() . PHP_EOL;

このPHPコードは、現在の時刻をRFC 7231という特定の形式でフォーマットし、文字列として取得する方法を示しています。RFC 7231は、HTTP通信などで利用される日付フォーマットの国際標準であり、時刻は常にUTC（協定世界時、GMTと同等）で表現されるという特徴があります。

getCurrentDateTimeRfc7231関数は引数なしで呼び出すことができ、RFC 7231形式でフォーマットされた日時文字列を返します。関数内では、まずnew DateTimeImmutable('now', new DateTimeZone('UTC'))を使用して、現在の時刻をUTCタイムゾーンのDateTimeImmutableオブジェクトとして取得します。これは、RFC 7231の仕様で時刻がUTCで表現されることが求められているためです。

次に、この日時オブジェクトのformatメソッドを呼び出し、引数にDateTimeImmutable::RFC7231定数を指定します。この定数は、RFC 7231の要件に合致する具体的なフォーマット文字列（例: 'D, d M Y H:i:s T'）を内部的に保持しており、開発者が複雑なフォーマット文字列を覚えることなく、標準的な日時文字列を容易に生成できるように設計されています。

結果として、この関数は「Tue, 15 Nov 1994 12:45:26 GMT」のような形式の日時文字列を戻り値として提供します。この形式は、Webサーバーとクライアント間の日時情報のやり取りなど、システム間で正確な時間同期が必要な場面で特に役立ちます。