【PHP8.x】setDateメソッドの使い方

Copy
1<?php
2
3/**
4 * DateTime::setDate() メソッドの使用例を示します。
5 * 既存の DateTime オブジェクトの日付部分を設定します。
6 */
7function demonstrateDateTimeSetDate(): void
8{
9    // 現在の日時で DateTime オブジェクトを作成します。
10    // 時刻部分はそのまま維持されます。
11    $dateTime = new DateTime();
12    echo "元のDateTimeオブジェクト: " . $dateTime->format('Y-m-d H:i:s') . PHP_EOL;
13
14    // setDate() メソッドを使用して、日付を2023年10月26日に変更します。
15    // setDate() は変更された DateTime オブジェクト自身を返します。
16    $dateTime->setDate(2023, 10, 26);
17
18    // 日付が変更されたことを確認します。
19    echo "setDate() 後のDateTimeオブジェクト: " . $dateTime->format('Y-m-d H:i:s') . PHP_EOL;
20
21    // 別の日に変更してみます。
22    $dateTime->setDate(2025, 1, 15);
23    echo "再度setDate() 後のDateTimeオブジェクト: " . $dateTime->format('Y-m-d H:i:s') . PHP_EOL;
24
25    // チェーン呼び出しも可能です。
26    $newDate = (new DateTime())->setDate(2024, 7, 4);
27    echo "新しいDateTimeオブジェクトを作成しsetDate() をチェーン: " . $newDate->format('Y-m-d H:i:s') . PHP_EOL;
28}
29
30// 関数の実行
31demonstrateDateTimeSetDate();
32
33?>

DateTime::setDate()は、PHPのDateTimeオブジェクトが持つ日付部分を変更するための重要なメソッドです。このメソッドを利用することで、既存のDateTimeオブジェクトの「年」「月」「日」だけを新しい値に設定し、時刻（時、分、秒）は変更せずにそのまま維持することができます。

引数には、変更したい日付の「年」を$year、その年の「月」を$month、そしてその月の「日」を$dayとして、それぞれ整数で指定します。例えば、日付を2023年10月26日に設定したい場合は、setDate(2023, 10, 26)のように記述します。

このメソッドの戻り値は、日付が変更されたDateTimeオブジェクトそのものです。そのため、メソッドを呼び出した元のオブジェクトが直接更新され、その更新されたオブジェクトが返されるため、続けて他のDateTimeメソッドをチェーンして呼び出すことも可能です。

サンプルコードでは、最初に現在のシステム日時でDateTimeオブジェクトを生成し、その日時を表示しています。その後、setDate(2023, 10, 26)を呼び出すことで、オブジェクトの日付部分が指定された日付に更新され、時刻は変更されていないことが確認できます。さらに、日付を再度変更する例や、新しくオブジェクトを作成してすぐにsetDate()をチェーンして日付を設定する例も示されており、setDate()が日付操作をいかに簡潔にするかを示しています。

Copy
1<?php
2
3// DateTimeオブジェクトを現在のシステム日時で初期化します。
4// これは日付と時刻の両方を含みます。
5$dateTime = new DateTime();
6echo "初期日時: " . $dateTime->format('Y-m-d H:i:s') . "\n";
7
8// setDateメソッドを使用して、既存のDateTimeオブジェクトの日付部分のみを変更します。
9// 引数: 年 (int $year), 月 (int $month), 日 (int $day)
10// 時刻部分は変更されず、現在のオブジェクトのものが維持されます。
11// setDateメソッドは変更されたDateTimeオブジェクト自体を返します。
12$dateTime->setDate(2023, 1, 1);
13
14// 変更後の日時を表示します。時刻は初期のままですが、日付は2023年1月1日になっています。
15echo "setDate適用後 (2023年1月1日に設定): " . $dateTime->format('Y-m-d H:i:s') . "\n";
16
17// 別の例: 新しいDateTimeオブジェクトを作成し、日付を設定する
18$christmas = new DateTime();
19$christmas->setDate(2024, 12, 25); // 2024年12月25日に設定
20
21// 設定された日付と、初期の時刻を持つDateTimeオブジェクトを表示
22echo "別の例 (2024年12月25日に設定): " . $christmas->format('Y-m-d H:i:s') . "\n";
23
24?>

PHPのDateTime::setDateメソッドは、既存のDateTimeオブジェクトの日付部分のみを変更するために使用される便利な機能です。このメソッドはPHP 8以降で利用できます。

まず、new DateTime()を使って現在のシステム日時を持つDateTimeオブジェクトを作成します。このオブジェクトは、作成時の日付と時刻の両方の情報を含んでいます。

その後、setDateメソッドを呼び出すことで、オブジェクトに設定されている日付を変更できます。このメソッドは引数として、年を表す整数$year、月を表す整数$month、日を表す整数$dayの3つを受け取ります。例えば、$dateTime->setDate(2023, 1, 1);と記述することで、$dateTimeオブジェクトの日付を2023年1月1日に設定できます。

このメソッドの重要な特徴は、日付部分のみを変更し、時刻部分は元のオブジェクトの値をそのまま維持する点です。そのため、既存の時刻情報を保持しつつ、効率的に日付を変更したい場合に非常に役立ちます。setDateメソッドは、変更されたDateTimeオブジェクト自身を戻り値として返します。

サンプルコードでは、現在のシステム日時で初期化したDateTimeオブジェクトの日付をsetDateメソッドで2023年1月1日に変更し、時刻部分が変わらず維持されていることを示しています。また、別の例として2024年12月25日を設定し、同様の挙動を確認できます。このメソッドを理解することで、PHPでの日付操作がより柔軟に行えるようになります。