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

Copy
1<?php
2
3// DatePeriod を使用して、ある期間の日付をイテレートする
4$start = new DateTime('2023-10-01');
5$end = new DateTime('2023-10-31');
6$interval = new DateInterval('P1D'); // 1日ごとの間隔
7$period = new DatePeriod($start, $interval, $end);
8
9// DatePeriod オブジェクトをイテレートし、現在の日付を取得する
10foreach ($period as $date) {
11    // DatePeriod::current() を使用して現在の日付 (DateTimeInterface) を取得する
12    $currentDate = $period->current();
13
14    // 現在の日付をフォーマットして表示する
15    echo $currentDate->format('Y-m-d') . PHP_EOL;
16}

PHPのDatePeriodクラスにおけるcurrentメソッドは、イテレータの現在位置にある要素、つまり現在の日付や時刻を表すDateTimeInterfaceオブジェクトを返します。DatePeriodは、ある期間にわたる日付や時刻のシーケンスを生成するために使用されるクラスです。このサンプルコードでは、2023年10月1日から2023年10月31日までの期間を1日ごとにイテレートしています。

foreachループ内で$period->current()を呼び出すことで、ループの現在のイテレーションにおけるDateTimeInterfaceオブジェクトを取得できます。このオブジェクトは、現在の日付を表しており、format()メソッドを使用して、特定の日付形式（この例では'Y-m-d'）で文字列として出力されます。

currentメソッドは引数を必要としません。もし期間内に要素が存在しない場合、falseを返します。DatePeriodオブジェクトをイテレートする際に、現在の日付や時刻を正確に取得し、操作するために、currentメソッドは非常に役立ちます。例えば、特定の日付に基づいて条件分岐を行ったり、日付の情報を表示したりする場合に活用できます。このサンプルコードでは、取得した日付をフォーマットして標準出力に表示しています。

Copy
1<?php
2
3// DatePeriod オブジェクトを作成
4$start = new DateTime('2024-01-01');
5$end = new DateTime('2024-01-05');
6$interval = new DateInterval('P1D'); // 1日おき
7$period = new DatePeriod($start, $interval, $end);
8
9// DatePeriod オブジェクトの現在の DateTimeInterface オブジェクトを取得
10$currentDate = $period->current();
11
12// 現在の日付が存在する場合、フォーマットして出力
13if ($currentDate) {
14    echo $currentDate->format('Y-m-d') . PHP_EOL; // 2024-01-01
15}
16
17// DatePeriod をイテレートしてcurrent() メソッドの挙動を確認
18foreach ($period as $date) {
19    $currentDate = $period->current(); // ループ中でも current() は常に現在の日付を返す
20    echo "Current Date inside loop: " . $currentDate->format('Y-m-d') . PHP_EOL;
21}
22
23?>

このサンプルコードは、PHPのDatePeriodクラスにおけるcurrent()メソッドの使い方を示しています。current()メソッドは、DatePeriodオブジェクトが現在指し示しているDateTimeInterfaceオブジェクトを返します。DatePeriodは、指定された開始日から終了日までの、特定の間隔を持つ日付と時刻のイテレータを提供するクラスです。

まず、DateTimeオブジェクト（開始日と終了日）とDateIntervalオブジェクト（間隔）を使用してDatePeriodオブジェクトを作成します。

次に、$period->current()を呼び出すことで、DatePeriodオブジェクトが最初に指し示しているDateTimeInterfaceオブジェクトを取得します。この例では、開始日のDateTimeオブジェクトが返されます。返り値はDateTimeInterface型、またはDatePeriodが空の場合（例えば、終了日が開始日より前の場合など）はfalseを返します。

その後、if文でcurrentDateがfalseでないことを確認してから、format()メソッドを使って日付をY-m-d形式でフォーマットし、出力しています。

さらに、foreachループを使用してDatePeriodオブジェクトをイテレートしています。ループ内で$period->current()を呼び出すと、各イテレーションにおいてDatePeriodが現在指し示しているDateTimeInterfaceオブジェクトが返されます。ループ内でcurrent()を呼び出すことは、イテレーションの進行には影響を与えません。current()は常に現在のイテレータの位置にあるDateTimeInterfaceオブジェクトを返します。この例では、ループ内でcurrent()を呼び出していますが、これはイテレータの位置を進めるものではなく、単に現在のDateTimeInterfaceオブジェクトを取得しているだけです。DatePeriodオブジェクトのイテレーションは、foreachループによって自動的に進められます。