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

Copy
1<?php
2
3/**
4 * 指定された日付に日数を追加し、結果の日付と曜日をフォーマットして返します。
5 *
6 * この関数は、日付に日数を加算する (`adddays` キーワード) 処理と、
7 * `IntlDateFormatter` を使用して曜日を国際化された形式で表示する方法を示します。
8 *
9 * PHPのリファレンス情報に「ABDAY_3」という定数が記載されていますが、
10 * これは標準のPHP 8環境においてグローバル定数として定義されていません。
11 * `ABDAY_3` は通常、曜日を短縮形で表現するフォーマットスタイル（例: 木, Thu）を
12 * 意図していると解釈されるため、ここでは `IntlDateFormatter` のパターン `'EEE'` を使用し、
13 * その意図を反映させています。`intl` 拡張が有効である必要があります。
14 *
15 * @param string $startDateStr 基準となる日付文字列 (例: '2023-10-26')
16 * @param int $daysToAdd 追加する日数
17 * @param string $locale 結果をフォーマットするロケール (例: 'ja_JP', 'en_US')
18 * @return string フォーマットされた日付と曜日を含む文字列、またはエラーメッセージ
19 */
20function addDaysAndFormatDateWithWeekday(string $startDateStr, int $daysToAdd, string $locale = 'en_US'): string
21{
22    // 1. 日付オブジェクトの作成
23    // 無効な日付文字列が渡された場合のエラーを処理します。
24    try {
25        $date = new DateTime($startDateStr);
26    } catch (Exception $e) {
27        return "エラー: 無効な開始日付文字列です。({$e->getMessage()})";
28    }
29
30    // 2. 日数を追加する (キーワード: adddays)
31    // DateTime::modify() メソッドを使って、指定された日数を日付に加算します。
32    $date->modify("+$daysToAdd days");
33
34    // 3. 曜日を含めて日付をフォーマット
35    // `intl` 拡張機能が有効か確認します。国際化された日付フォーマットに必要です。
36    if (!extension_loaded('intl')) {
37        return "エラー: intl 拡張機能がロードされていません。PHPの設定を確認してください。";
38    }
39
40    // IntlDateFormatter を使用して、指定されたロケールで日付と曜日をフォーマットします。
41    // 'EEE' は短縮形の曜日（例: '日', 'Sun'）を表すパターンです。
42    $formatter = IntlDateFormatter::create(
43        $locale,
44        IntlDateFormatter::FULL,  // 日付部分のスタイル (例: '2023年10月29日' または 'October 29, 2023')
45        IntlDateFormatter::NONE,  // 時間部分はフォーマットしない
46        'UTC',                    // タイムゾーン (ここでは曜日の決定に影響しないが設定は必要)
47        IntlDateFormatter::GREGORIAN,
48        'yyyy/MM/dd (EEE)'        // フォーマットパターン例: '2023/10/29 (日)'
49    );
50
51    // フォーマッタの作成に失敗した場合のエラーを処理します。
52    if ($formatter === null) {
53        return "エラー: IntlDateFormatter の作成に失敗しました。ロケールやタイムゾーンを確認してください。";
54    }
55
56    // フォーマットされた日付と曜日を含む文字列を返します。
57    return $formatter->format($date);
58}
59
60// --- サンプル使用例 ---
61// システムエンジニアを目指す初心者の方へ:
62// このコードは、PHPで日付を操作し、その結果を特定の言語（ロケール）に合わせて
63// フォーマットする方法を示しています。
64// 実行には `intl` 拡張機能がPHPにインストールされ、有効になっている必要があります。
65
66// 基準となる日付と追加する日数を設定します。
67$initialDate = '2023-10-26'; // 例: 木曜日
68$daysToAdvance = 3;          // 3日進める
69
70echo "基準日: {$initialDate}, 追加日数: {$daysToAdvance}\n";
71
72// 日本語ロケールでの結果を表示します。
73$resultJa = addDaysAndFormatDateWithWeekday($initialDate, $daysToAdvance, 'ja_JP');
74echo "日本語 (ja_JP): " . $resultJa . "\n"; // 出力例: 2023/10/29 (日)
75
76// 英語ロケールでの結果を表示します。
77$resultEn = addDaysAndFormatDateWithWeekday($initialDate, $daysToAdvance, 'en_US');
78echo "英語 (en_US): " . $resultEn . "\n"; // 出力例: 2023/10/29 (Sun)
79
80echo "\n--- 別の使用例 ---\n";
81$initialDate2 = '2024-02-28'; // 2024年はうるう年です
82$daysToAdvance2 = 2;
83echo "基準日: {$initialDate2}, 追加日数: {$daysToAdvance2}\n";
84echo "日本語 (ja_JP): " . addDaysAndFormatDateWithWeekday($initialDate2, $daysToAdvance2, 'ja_JP') . "\n"; // 出力例: 2024/03/01 (金)
85echo "英語 (en_US): " . addDaysAndFormatDateWithWeekday($initialDate2, $daysToAdvance2, 'en_US') . "\n"; // 出力例: 2024/03/01 (Fri)
86
87?>

このPHPサンプルコードは、特定の日付に指定された日数を加え、その結果を国際化された形式で表示する方法をシステムエンジニアを目指す初心者の方にわかりやすく示しています。PHPリファレンスにある ABDAY_3 という定数は、標準のPHP 8環境では直接利用できませんが、曜日を短縮形で表現するというその意図を IntlDateFormatter クラスとパターン 'EEE' を使用して実現しています。

関数 addDaysAndFormatDateWithWeekday は、まず $startDateStr で与えられた日付文字列を元に DateTime オブジェクトを作成します。次に、$daysToAdd で指定された日数を modify メソッドで日付に加算します。これは php adddays というキーワードで示される日付加算の処理に当たります。その後、IntlDateFormatter を利用し、指定された $locale（言語と地域）に合わせて「年/月/日 (曜日)」の形式で日付と曜日をフォーマットします。

引数の $startDateStr は基準となる日付の文字列、$daysToAdd は加算したい日数、$locale は結果の表示形式を決定するロケールです。関数はフォーマットされた日付と曜日を含む文字列を返すか、処理中に問題があった場合にはエラーメッセージを返します。この機能を利用するには、PHPに intl 拡張機能がインストールされ、有効になっている必要があります。

Copy
1<?php
2
3/**
4 * 指定された日付に指定された日数を加算します。
5 * システムエンジニアを目指す初心者の方にも理解しやすいよう、
6 * PHP 8 で推奨される DateTime オブジェクトと DateInterval クラスを使用しています。
7 *
8 * @param string $dateString 加算の基準となる日付を表す文字列 (例: '2023-01-15' または 'now')。
9 * @param int $daysToAdd 加算する日数。正の数で未来、負の数で過去の日付を計算できます。
10 * @return string 加算後の日付を 'YYYY-MM-DD' 形式の文字列で返します。
11 * @throws Exception 無効な日付文字列が渡された場合に例外をスローします。
12 */
13function addDaysToDate(string $dateString, int $daysToAdd): string
14{
15    try {
16        // 基準となるDateTimeオブジェクトを作成
17        // 'now' を指定すると現在の日付と時刻で初期化されます。
18        $date = new DateTime($dateString);
19
20        // DateIntervalオブジェクトを作成し、加算する日数を指定します。
21        // 'P' は期間指定、'D' は日数を意味します。
22        // 例: 'P3D' は3日間を意味します。
23        $intervalString = "P" . abs($daysToAdd) . "D"; // 日数の絶対値を使用
24        $interval = new DateInterval($intervalString);
25
26        // add() メソッドまたは sub() メソッドを使って日付に期間を加算/減算します。
27        if ($daysToAdd >= 0) {
28            $date->add($interval);
29        } else {
30            $date->sub($interval);
31        }
32
33        // フォーマットして結果の日付文字列を返します。
34        return $date->format('Y-m-d');
35    } catch (Exception $e) {
36        // 日付のパース失敗など、DateTimeオブジェクトの作成でエラーが発生した場合の処理
37        throw new Exception("日付の処理中にエラーが発生しました: " . $e->getMessage());
38    }
39}
40
41// --- サンプル使用例 ---
42
43try {
44    // 1. 今日の日付から3日後を計算
45    $today = date('Y-m-d');
46    $dateAfter3Days = addDaysToDate($today, 3);
47    echo "今日 ({$today}) の3日後: {$dateAfter3Days}\n";
48
49    // 2. 特定の日付から7日後を計算
50    $specificDate = '2023-10-26';
51    $dateAfter7Days = addDaysToDate($specificDate, 7);
52    echo "{$specificDate} の7日後: {$dateAfter7Days}\n";
53
54    // 3. 特定の日付から5日前を計算 (負の数を指定)
55    $dateBefore5Days = addDaysToDate($specificDate, -5);
56    echo "{$specificDate} の5日前: {$dateBefore5Days}\n";
57
58    // 4. 無効な日付文字列を渡した場合の例 (例外が発生します)
59    // $invalidDateResult = addDaysToDate('invalid-date-string', 10);
60    // echo $invalidDateResult; // この行は実行されず、catchブロックが処理されます
61} catch (Exception $e) {
62    // 例外発生時のエラーメッセージを表示
63    echo "エラー: " . $e->getMessage() . "\n";
64}
65
66?>

このPHPサンプルコードは、PHP 8で推奨される DateTime オブジェクトと DateInterval クラスを使用して、指定された日付に任意の日数を加算または減算する方法を解説しています。

addDaysToDate 関数は、$dateString という文字列で基準となる日付（例えば '2023-01-15' や 'now'）を受け取ります。また、$daysToAdd という整数で加算する日数を指定します。この $daysToAdd が正の数であれば未来の日付を、負の数であれば過去の日付を計算します。関数は、計算された日付を 'YYYY-MM-DD' 形式の文字列として返します。

処理の内部では、まず基準となる日付文字列から DateTime オブジェクトを作成します。次に、$daysToAdd の絶対値を使用して DateInterval オブジェクトを生成し、加算または減算する期間を定義します。そして、$daysToAdd の値に応じて DateTime オブジェクトの add() メソッドで日数を加えるか、sub() メソッドで日数を引きます。最後に format('Y-m-d') メソッドで日付を整形し、結果を返却します。無効な日付文字列が渡された場合には、エラーを示す例外がスローされるため、堅牢な日付処理を実現できます。