【PHP8.x】DATE_RFC7231定数の使い方

Copy
1<?php
2
3/**
4 * 現在の時刻を RFC 3339 形式で取得する関数。
5 *
6 * RFC 3339 は、インターネットで日付と時刻を表すための標準的なフォーマットです。
7 * ISO 8601に基づいた形式であり、WebサービスやAPIなどで広く利用されます。
8 * 例: 2004-02-12T15:19:21+00:00
9 *
10 * PHPでは、date() 関数と組み合わせて DATE_RFC3339 定数を使用することで、
11 * このフォーマットの日付文字列を簡単に生成できます。
12 *
13 * @return string 現在の時刻の RFC 3339 形式の文字列。
14 */
15function getCurrentTimeInRfc3339(): string
16{
17    // date() 関数は、指定されたフォーマット文字列に基づいて日付/時刻をフォーマットします。
18    // DATE_RFC3339 は PHP にあらかじめ定義されている定数で、
19    // RFC 3339 形式 ('Y-m-d\TH:i:sP') のフォーマット文字列を表します。
20    return date(DATE_RFC3339);
21}
22
23// 関数の実行例
24$rfc3339Time = getCurrentTimeInRfc3339();
25
26// 生成された RFC 3339 形式の日付文字列を出力します。
27echo "現在の時刻 (RFC 3339 形式): " . $rfc3339Time . PHP_EOL;
28

このPHPサンプルコードは、現在の時刻を「RFC 3339」という形式で取得する方法を示しています。RFC 3339は、インターネット上で日付と時刻を表現するための標準的なフォーマットの一つで、WebサービスやAPIなどで日付情報をやり取りする際に広く利用されます。例えば、「2004-02-12T15:19:21+00:00」のような形式が該当します。

コードでは、getCurrentTimeInRfc3339という関数を定義しています。この関数は引数を取りませんが、現在の時刻をRFC 3339形式の文字列として戻り値で返します。関数内部では、PHPの組み込み関数であるdate()を使用しています。date()関数は、第一引数に指定されたフォーマット文字列に基づいて日付や時刻を整形する役割を持ちます。

ここで利用されているDATE_RFC3339は、PHPに標準で用意されている定数です。この定数には、RFC 3339形式（具体的には'Y-m-d\TH:i:sP'）に整形するための文字列が格納されています。そのため、date(DATE_RFC3339)と記述するだけで、開発者が複雑なフォーマット文字列を覚えることなく、簡単にRFC 3339形式の日付時刻文字列を生成できます。

最後に、定義した関数を呼び出してその結果を変数に格納し、画面に出力しています。これにより、Webサービスなどで利用しやすい標準的な形式で現在時刻が表示されることを確認できます。

Copy
1<?php
2
3/**
4 * 現在の日付をRFC 7231形式（HTTP Dateヘッダー形式）で出力します。
5 *
6 * この関数は、PHPのDateTimeクラスとDATE_RFC7231定数を使用して、
7 * 日付を特定の標準形式にフォーマットする方法を示します。
8 */
9function displayRfc7231Date(): void
10{
11    // 現在の日付と時刻を表すDateTimeオブジェクトを作成します。
12    // DateTimeクラスは、日付と時刻の操作を柔軟に行うためのPHPの推奨クラスです。
13    $now = new DateTime();
14
15    // DATE_RFC7231定数を使って、DateTimeオブジェクトをRFC 7231形式の文字列にフォーマットします。
16    // この形式は、HTTPヘッダーなどで利用される標準的な日付書式です。
17    $formattedDate = $now->format(DATE_RFC7231);
18
19    echo "RFC 7231 形式の日付: " . $formattedDate . PHP_EOL;
20
21    // 参考: キーワードにあったDATE_RFC2822も同様に日付フォーマット定数です。
22    //       PHPには他にも多くの日付フォーマット定数が用意されています。
23    // 例: echo "RFC 2822 形式の日付: " . $now->format(DATE_RFC2822) . PHP_EOL;
24}
25
26// 上記の関数を実行し、フォーマットされた日付を表示します。
27displayRfc7231Date();

このPHPサンプルコードは、現在の日付と時刻をRFC 7231形式という特定の標準書式で出力する方法を示しています。

まず、new DateTime()を使用して、現在の日付と時刻を表すDateTimeオブジェクトを作成します。DateTimeクラスは、PHPで日付と時刻を柔軟に操作するための推奨されるクラスです。

次に、作成した$nowオブジェクトのformat()メソッドを呼び出します。このメソッドは、DateTimeオブジェクトの値を指定された書式に変換し、文字列として返します。ここで引数として渡されているDATE_RFC7231は、PHPに組み込まれている定数の一つで、日付を「RFC 7231」という標準的なHTTP Dateヘッダー形式でフォーマットするように指示します。この定数自体は引数を持ちません。

displayRfc7231Date関数はこれらの処理を実行し、フォーマットされた日付を画面に出力します。この関数自体は、直接的な戻り値を持たない（void）設計です。

参考として、キーワードにあったDATE_RFC2822も同様に日付フォーマットの標準を示す定数です。PHPにはDATE_RFC7231の他にも、DATE_RFC2822のように目的に応じた様々な日付フォーマット定数が用意されており、それぞれが異なる日付の表現形式に対応しています。