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

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オブジェクトを返します。

構文(syntax)

1public readonly DateTime $start

引数(parameters)

引数なし

引数はありません

戻り値(return)

DateTimeInterface

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

サンプルコード

PHP DatePeriod startプロパティで開始日を取得する

1<?php
2
3// DatePeriod オブジェクトから開始日を取得する例
4$start_date = new DateTime('2024-01-01');
5$end_date = new DateTime('2024-01-10');
6$interval = new DateInterval('P1D'); // 1日ごとの間隔
7
8$period = new DatePeriod($start_date, $interval, $end_date);
9
10// DatePeriodオブジェクトの開始日を取得
11$start = $period->start;
12
13// 開始日の情報を出力
14echo "開始日: " . $start->format('Y-m-d H:i:s') . PHP_EOL;
15
16// DatePeriodのstartプロパティはDateTimeInterfaceを返すため、DateTimeInterfaceのメソッドを利用可能
17if ($start->format('Y') === '2024') {
18    echo "開始年は2024年です。" . PHP_EOL;
19}
20

このサンプルコードは、PHPのDatePeriodクラスにおけるstartプロパティの利用方法を示しています。DatePeriodは、日付や時刻の範囲を表現するためのクラスです。startプロパティは、その期間の開始日をDateTimeInterfaceオブジェクトとして返します。

コードではまず、DateTimeオブジェクトで開始日と終了日、そしてDateIntervalオブジェクトで日付の間隔を定義し、これらを用いてDatePeriodオブジェクトを生成しています。

次に、$period->startと記述することで、DatePeriodオブジェクト $period の開始日を取得し、$start変数に格納しています。startプロパティはDateTimeInterfaceを返すため、DateTimeInterfaceが持つformat()メソッドを利用して、開始日を指定された形式(ここでは'Y-m-d H:i:s')で文字列として出力しています。

さらに、DateTimeInterfaceのメソッドを利用できる例として、format('Y')で年を取得し、それが'2024'であるかどうかを比較しています。このように、startプロパティから取得したDateTimeInterfaceオブジェクトに対しては、日付や時刻に関する様々な操作を行うことができます。

このサンプルを通して、DatePeriodオブジェクトから開始日を簡単に取得し、その日付情報を操作する方法を理解することができます。DatePeriodstartプロパティを効果的に利用することで、日付範囲を扱う処理をより柔軟かつ簡潔に記述することが可能になります。

DatePeriodオブジェクトのstartプロパティは、期間の開始日をDateTimeInterface型で返します。DateTimeInterfaceはインターフェースなので、直接インスタンス化はできませんが、DateTimeオブジェクトとして扱えます。そのため、format()メソッドなど、DateTimeオブジェクトで使用できるメソッドをそのまま利用可能です。

取得したstartプロパティは、DatePeriodオブジェクト生成時に指定したDateTimeオブジェクトへの参照です。startプロパティを通して開始日の値を変更すると、元のDateTimeオブジェクトにも影響を与える可能性があります。意図しない変更を防ぐためには、cloneを使用して新しいDateTimeオブジェクトを作成してから操作することを推奨します。

PHP DatePeriodから開始日を取得する

1<?php
2
3// DatePeriod オブジェクトを作成し、開始日時を取得する例
4try {
5    $startDate = new DateTime('2024-01-01');
6    $endDate = new DateTime('2024-01-10');
7    $interval = new DateInterval('P1D'); // 1日ごとの間隔
8
9    $period = new DatePeriod($startDate, $interval, $endDate);
10
11    // DatePeriod の開始日時を取得
12    $periodStart = $period->start;
13
14    // 開始日時を表示
15    echo "開始日時: " . $periodStart->format('Y-m-d H:i:s') . PHP_EOL;
16
17} catch (Exception $e) {
18    echo "例外発生: " . $e->getMessage() . PHP_EOL;
19}

このサンプルコードは、PHPのDatePeriodクラスのstartプロパティを使って、期間の開始日時を取得する方法を示しています。

DatePeriodは、指定された開始日時から終了日時までの、一定間隔の日時のシーケンスを表すクラスです。この例では、まずDateTimeオブジェクトを使って2024年1月1日を開始日時、2024年1月10日を終了日時として設定し、DateIntervalオブジェクトで1日ごとの間隔を指定しています。これらの情報をもとにDatePeriodオブジェクトを生成します。

$period->startと記述することで、DatePeriodオブジェクトが表す期間の開始日時(DateTimeInterface型)を取得できます。取得した開始日時は、format()メソッドを使って指定した形式(ここでは'Y-m-d H:i:s')の文字列に変換され、画面に出力されます。

startプロパティは引数を持ちません。DatePeriodオブジェクトが保持する開始日時をDateTimeInterface型で返します。もしDatePeriodオブジェクトの生成時に例外が発生した場合、catchブロックで例外を捕捉し、エラーメッセージを表示します。この例では、try-catchブロックを使用することで、例外が発生した場合でもプログラムが異常終了しないようにしています。

DatePeriodオブジェクトのstartプロパティは、期間の開始日時をDateTimeInterface型で返します。直接値を設定することはできません。DatePeriodオブジェクト作成時に指定した開始日時が取得されます。開始日時を後から変更したい場合は、新しいDatePeriodオブジェクトを作成する必要があります。サンプルコードでは、例外処理を行っていますが、日付の形式が正しくない場合などにDateTimeコンストラクタで例外が発生する可能性があるため、try-catchブロックで囲むようにしましょう。format()メソッドを利用して、取得した日時を適切な形式で表示できます。

関連コンテンツ

関連プログラミング言語