【PHP8.x】date_date_set関数の使い方

Copy
1<?php
2
3/**
4 * date_date_set 関数の使用例を示す関数。
5 * この関数はDateTimeオブジェクトの日付部分（年、月、日）を設定します。
6 * 有効な日付と無効な日付の両方のケースを示し、戻り値の型 `DateTime|false` に対応します。
7 */
8function exampleDateDateSet(): void
9{
10    echo "--- 有効な日付の設定例 ---\n";
11    // 1. 現在の日付と時刻でDateTimeオブジェクトを初期化
12    $dateTimeSuccess = new DateTime();
13    echo "初期の日付: " . $dateTimeSuccess->format('Y-m-d H:i:s') . "\n";
14
15    // 2. date_date_set を使って日付部分を2025年1月1日に設定
16    $yearSuccess = 2025;
17    $monthSuccess = 1;
18    $daySuccess = 1;
19    // 成功するとDateTimeオブジェクト自体が返され、失敗するとfalseが返されます。
20    $resultSuccess = date_date_set($dateTimeSuccess, $yearSuccess, $monthSuccess, $daySuccess);
21
22    // 3. 設定が成功したか確認し、結果を出力
23    if ($resultSuccess instanceof DateTime) {
24        echo "日付設定後の日付: " . $dateTimeSuccess->format('Y-m-d H:i:s') . "\n";
25        echo "（時刻部分は変更されていません）\n";
26    } else {
27        // 通常、有効な日付ではこのブロックには入りません
28        echo "日付設定に失敗しました。\n";
29        echo "DateTimeオブジェクトは変更されていません: " . $dateTimeSuccess->format('Y-m-d H:i:s') . "\n";
30    }
31
32    echo "\n--- 無効な日付の設定例 ---\n";
33    // 1. 別のDateTimeオブジェクトを初期化
34    $dateTimeFailure = new DateTime();
35    echo "初期の日付: " . $dateTimeFailure->format('Y-m-d H:i:s') . "\n";
36
37    // 2. date_date_set を使って無効な日付部分を設定 (例: 2月30日)
38    $yearFailure = 2024; // 閏年でも2月30日は存在しません
39    $monthFailure = 2;
40    $dayFailure = 30;
41    $resultFailure = date_date_set($dateTimeFailure, $yearFailure, $monthFailure, $dayFailure);
42
43    // 3. 設定が成功したか確認し、結果を出力
44    if ($resultFailure instanceof DateTime) {
45        // 無効な日付を指定した場合、通常このブロックには入りません
46        echo "日付設定後の日付: " . $dateTimeFailure->format('Y-m-d H:i:s') . "\n";
47    } else {
48        // 無効な日付のため、設定は失敗しfalseが返されます。
49        // DateTimeオブジェクトは変更されずに元の値のままです。
50        echo "無効な日付 (" . $yearFailure . "年" . $monthFailure . "月" . $dayFailure . "日) のため、日付設定に失敗しました。\n";
51        echo "DateTimeオブジェクトは変更されていません: " . $dateTimeFailure->format('Y-m-d H:i:s') . "\n";
52    }
53}
54
55// 関数の実行
56exampleDateDateSet();

date_date_set関数は、PHPで日付と時刻を扱うDateTimeオブジェクトに対して、その日付部分（年、月、日）を設定するための関数です。第一引数には日付を設定したいDateTimeオブジェクトを渡し、第二引数に年、第三引数に月、第四引数に日を整数で指定します。

この関数が正常に処理されると、日付が更新されたDateTimeオブジェクト自身が返されます。この際、時刻部分は変更されず、日付部分のみが指定された値に更新されます。しかし、例えば「2月30日」のように存在しない無効な日付を指定した場合、この関数は失敗し、戻り値としてfalseを返します。設定が失敗した場合は、元のDateTimeオブジェクトは変更されずにそのままの状態を保ちます。

提供されたサンプルコードでは、まず有効な日付（2025年1月1日）を設定し、DateTimeオブジェクトが正しく更新される様子を示しています。次に、無効な日付（2月30日）を設定する例を通じて、関数がfalseを返し、元のDateTimeオブジェクトが変更されないという挙動を具体的に確認できます。これにより、この関数の使い方と安全なエラーハンドリングの方法を学ぶことができます。