【PHP8.x】startプロパティの使い方

startプロパティは、DatePeriodオブジェクトが表す期間の開始日時を保持するプロパティです。DatePeriodクラスは、特定の日時から別の日時までの日付と時刻の繰り返し処理を容易にするために使用されます。startプロパティは、DatePeriodが開始されるDateTimeInterfaceオブジェクトを格納します。このDateTimeInterfaceオブジェクトは、期間の開始点を定義し、イテレーションの最初の値となります。

DatePeriodオブジェクトを作成する際に、開始日時、期間、終了日時または繰り返し回数を指定します。startプロパティは、指定された開始日時をDateTimeInterfaceオブジェクトとして保持します。このプロパティは、DatePeriodオブジェクトが表す期間の始まりを知るために不可欠です。

例えば、特定の日から1週間ごとの日付を繰り返し処理するDatePeriodオブジェクトを作成した場合、startプロパティはその特定の日を表すDateTimeInterfaceオブジェクトを保持します。DatePeriodオブジェクトをイテレートすると、startプロパティに格納された開始日時から始まり、指定された期間に基づいて日付が順番に生成されます。

startプロパティは読み取り専用であり、直接値を変更することはできません。期間の開始日時を変更するには、新しいDatePeriodオブジェクトを作成する必要があります。startプロパティにアクセスすることで、DatePeriodオブジェクトがいつから開始されるかを正確に把握し、期間内の日付と時刻の計算や処理を行うことができます。DateTimeImmutableオブジェクトが使用される場合、startプロパティはDateTimeImmutableオブジェクトを返します。それ以外の場合はDateTimeオブジェクトを返します。

Copy
1public readonly DateTime $start

DateTimeInterface

DatePeriodオブジェクトの開始日時を表すDateTimeInterfaceオブジェクトを返します。