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

getStartDateメソッドは、DatePeriodオブジェクトに設定されている期間の開始日時を取得するメソッドです。DatePeriodクラスは、開始日時、終了日時、そして時間間隔を指定することで、特定の期間内の一連の日付や時刻の繰り返しを表現します。例えば、「毎週月曜日」や「1ヶ月ごとの15日」といった周期的な日付の集まりを扱う際に利用されます。このgetStartDateメソッドを使用すると、そのDatePeriodオブジェクトがどの時点から始まっているのかを正確に知ることができます。メソッドの戻り値は、日付と時刻の情報を保持するDateTimeInterface型のオブジェクトです。これは通常、DateTimeまたはDateTimeImmutableオブジェクトであり、DatePeriodオブジェクトを生成する際にコンストラクタで指定した開始日時の情報と完全に一致します。例えば、あるタスクの繰り返し期間を管理するプログラムで、その期間の最初の実行日を確認したい場合などにこのメソッドが役立ちます。取得した開始日時オブジェクトに対して、フォーマットを変更して表示したり、他の日付との比較を行ったりすることが可能です。

Copy
1<?php
2
3// 期間オブジェクト (2023-01-01から1日おきに4回) を作成
4$datePeriod = new DatePeriod(
5    new DateTime('2023-01-01'),
6    new DateInterval('P1D'),
7    4
8);
9
10// DatePeriodオブジェクトから開始日を取得します
11$startDate = $datePeriod->getStartDate();
12
13// 取得した開始日を Y-m-d 形式で出力します
14echo $startDate->format('Y-m-d');
15
16?>

引数なし

引数はありません

DateTimeInterface

DatePeriod オブジェクトの開始日時を表す DateTimeInterface インターフェースを実装したオブジェクトを返します。