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

endプロパティは、DatePeriodオブジェクトが表す期間の終了日時を保持するプロパティです。このプロパティは、DateTimeImmutableオブジェクトとして値を持ちます。DatePeriodは、開始日時、終了日時、および期間を指定することで、連続したDateTimeImmutableオブジェクトのシーケンスを生成します。endプロパティは、このシーケンスが終了する日時を格納し、期間全体の終端を定義します。

DatePeriodオブジェクトが生成された後、endプロパティに直接新しいDateTimeImmutableオブジェクトを割り当てることはできません。DatePeriodオブジェクトの終了日時を変更したい場合は、新しいDatePeriodオブジェクトを生成する必要があります。

endプロパティは、DatePeriodオブジェクトの反復処理が完了した後に、期間の終了日時を確認するために使用できます。また、DatePeriodオブジェクトが表す期間の長さや、期間内の特定の日時が含まれているかどうかなどの検証にも役立ちます。

例えば、特定の期間におけるイベントのスケジュールを扱う場合、DatePeriodを使用して期間全体を反復処理し、endプロパティを使用して最終イベントの開催日時を確認することができます。このように、endプロパティは、DatePeriodオブジェクトが表す期間の終了時点を正確に把握し、日付と時刻に関連する様々な処理を効率的に行うために不可欠な役割を果たします。

Copy
1public readonly DateTimeInterface $end

DateTimeInterface|null

DatePeriodオブジェクトの終了日時を表すDateTimeInterfaceオブジェクト、または期間が終了しない場合はnullを返します。