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

Copy
1<?php
2
3/**
4 * DAY_5 定数について:
5 * この定数は、PHPの特定の拡張機能で定義される週の曜日を表すものと想定されます。
6 * 通常、週の5番目の曜日（金曜日）を指す整数値（例: 5）を持ちます。
7 * リファレンス情報に「戻り値なし」とありますが、これは定数が関数のように振る舞わず、
8 * 特定の値を保持するデータ型であることを意味すると解釈できます。
9 * PHPの `date('N')` 関数は月曜日を1、日曜日を7として曜日を返しますので、
10 * 金曜日は5に対応します。このサンプルコードでは、この一般的な慣例に従い5として定義します。
11 */
12if (!defined('DAY_5')) {
13    define('DAY_5', 5);
14}
15
16/**
17 * 指定された日付が DAY_5 (金曜日) であるかを判定します。
18 *
19 * @param string|null $dateString 判定したい日付文字列 (例: '2023-10-27')。
20 *                                  null の場合は現在の日付を使用します。
21 * @return bool 指定された日付が DAY_5 (金曜日) であれば true、そうでなければ false を返します。
22 */
23function isSpecificDay5(?string $dateString = null): bool
24{
25    // DateTimeImmutable オブジェクトを生成し、日付操作の安全性を高めます。
26    // 引数が null の場合、現在の日付と時刻を使用します。
27    $date = new DateTimeImmutable($dateString ?? 'now');
28
29    // date('N') フォーマットは、ISO-8601 週番号形式で曜日を返します。
30    // 月曜日が 1、火曜日が 2、...、金曜日が 5、...、日曜日が 7 となります。
31    $dayOfWeek = (int)$date->format('N');
32
33    // 取得した曜日番号が DAY_5 定数と一致するかを確認します。
34    return $dayOfWeek === DAY_5;
35}
36
37// --- サンプルコードの使用例 ---
38
39// 1. 今日が DAY_5 (金曜日) であるかを確認する
40if (isSpecificDay5()) {
41    echo "今日はDAY_5 (金曜日) です！\n";
42} else {
43    echo "今日はDAY_5 (金曜日) ではありません。\n";
44}
45
46echo "--------------------\n";
47
48// 2. 特定の日付が DAY_5 (金曜日) であるかを確認する
49$testDateFriday = '2023-10-27'; // 例: 2023年10月27日は金曜日
50if (isSpecificDay5($testDateFriday)) {
51    echo "{$testDateFriday} はDAY_5 (金曜日) です。\n";
52} else {
53    echo "{$testDateFriday} はDAY_5 (金曜日) ではありません。\n";
54}
55
56echo "--------------------\n";
57
58// 3. 別の特定の日付が DAY_5 (金曜日) であるかを確認する
59$testDateSaturday = '2023-10-28'; // 例: 2023年10月28日は土曜日
60if (isSpecificDay5($testDateSaturday)) {
61    echo "{$testDateSaturday} はDAY_5 (金曜日) です。\n";
62} else {
63    echo "{$testDateSaturday} はDAY_5 (金曜日) ではありません。\n";
64}

このPHPコードは、特定の日付が週の5番目の曜日であるかを判定する方法を示すサンプルです。まず、DAY_5という定数を数値の5として定義しています。この定数は、本来PHPの特定の拡張機能で定義される週の曜日を表すものですが、リファレンス情報にある「戻り値なし」は、定数が関数のように実行されるのではなく、特定の数値を保持するデータであることを意味します。一般的にPHPのdate('N')関数では月曜日を1、金曜日を5と数えるため、この定数は金曜日を指します。

isSpecificDay5関数は、指定された日付がDAY_5、つまり金曜日であるかを判定します。引数$dateStringには確認したい日付を文字列で渡すことができますが、省略した場合は現在の日付が使われます。この関数は内部でDateTimeImmutableオブジェクトを用いて日付を扱い、その日付の曜日番号を取得します。そして、取得した曜日番号がDAY_5定数と一致するかを比較し、金曜日であればtrueを、そうでなければfalseを戻り値として返します。コードの後半では、この関数を使って現在の日付や特定の日付が金曜日であるかを確認する具体的な使用例が示されています。

Copy
1<?php
2
3/**
4 * DAY_5 定数に関連する今日の曜日を判定するサンプル関数。
5 *
6 * このコードは、PHPエクステンションによってDAY_5という定数が定義されており、
7 * それが特定の曜日を示す数値（例えば、ISO 8601形式で金曜日を意味する5など）であると仮定しています。
8 * リファレンス情報に「戻り値なし」とありますが、定数は値を保持するものであり、
9 * ここではその値を利用する例を示します。
10 *
11 * システムエンジニアを目指す初心者の方へ：
12 * 定数はプログラムの実行中に変わらない値を保持します。
13 * DAY_5のような定数は、日付や時刻を扱う関数と組み合わせて使われることが多いです。
14 * この定数が定義されている環境で実行することで、その実際の値と動作を確認できます。
15 */
16function checkDay5Status(): void
17{
18    echo "--- DAY_5 定数の利用例 ---\n";
19
20    // DAY_5 定数の値を出力します。
21    // この値は、この定数が定義されているエクステンションによって決定されます。
22    // 例: 5 (ISO 8601 形式の金曜日)
23    echo "DAY_5 の値: " . DAY_5 . "\n";
24
25    // 今日の曜日を数値で取得します (ISO 8601 形式: 月曜日=1, 火曜日=2, ..., 日曜日=7)。
26    $todayIsoWeekday = (int)date('N');
27    echo "今日の曜日 (ISO 8601 形式): " . $todayIsoWeekday . "\n";
28
29    // DAY_5 の値が今日の曜日と一致するかを判定します。
30    // 例えば、DAY_5が「金曜日」を意味する5である場合、金曜日にこのコードを実行すると一致します。
31    if ($todayIsoWeekday === DAY_5) {
32        echo "今日はDAY_5が示す曜日に該当します。\n";
33    } else {
34        echo "今日はDAY_5が示す曜日に該当しません。\n";
35    }
36}
37
38// サンプル関数を実行します。
39checkDay5Status();
40

このサンプルコードは、PHPエクステンションで定義される可能性のあるDAY_5定数の利用例を示しています。DAY_5は、特定の曜日を示す数値（例えばISO 8601形式で金曜日を意味する5）を保持する定数として想定されています。定数はプログラムの実行中にその値が変わらない特性を持ち、特定の意味を持つ数値をコード内で分かりやすく扱うために使用されます。

コードでは、まずDAY_5定数が現在保持している値を出力しています。この値は、定数が定義されているPHPのエクステンションによって決定されます。次に、date('N')関数を用いて今日の曜日をISO 8601形式の数値（月曜日が1、火曜日が2、…、日曜日が7）で取得し、その値とDAY_5定数の値を比較しています。この比較により、今日がDAY_5が示す曜日に該当するかどうかを判断し、その結果を表示します。

定数自体には引数や戻り値という概念はありませんが、その保持する値をプログラムの論理判断や計算に利用することができます。システムエンジニアを目指す初心者の方にとって、定数は設定値や特定の意味を持つ識別子などをコード内で管理しやすくするための基本的な要素であり、日付や時刻を扱う場面で特定の曜日を示す値として活用されることがあります。