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

Copy
1<?php
2
3/**
4 * 指定された年月の最終日を返す関数。
5 *
6 * @param int $year 年。
7 * @param int $month 月。
8 * @return int 指定された年月の最終日。
9 */
10function getLastDayOfMonth(int $year, int $month): int
11{
12    return (int)date('t', mktime(0, 0, 0, $month, 1, $year));
13}
14
15/**
16 * 指定された年月の日付を生成する Generator 関数。
17 *
18 * @param int $year 年。
19 * @param int $month 月。
20 * @return Generator 日付を順番に返す Generator。
21 */
22function generateDatesOfMonth(int $year, int $month): Generator
23{
24    $lastDay = getLastDayOfMonth($year, $month);
25
26    for ($day = 1; $day <= $lastDay; $day++) {
27        yield new DateTimeImmutable("$year-$month-$day");
28    }
29}
30
31// 使用例：2024年1月の日付を順番に表示する
32$year = 2024;
33$month = 1;
34
35$dateGenerator = generateDatesOfMonth($year, $month);
36
37foreach ($dateGenerator as $date) {
38    echo $date->format('Y-m-d') . PHP_EOL;
39}
40
41// current() メソッドの使用例 (foreach ループ内で暗黙的に使われるため、ここでは直接的な使用例を示す)
42$dateGenerator->rewind(); // ジェネレータを初期位置に戻す
43$firstDate = $dateGenerator->current();
44if ($firstDate instanceof DateTimeImmutable) {
45  echo "最初の日: " . $firstDate->format('Y-m-d') . PHP_EOL;
46} else {
47  echo "ジェネレータが空です。" . PHP_EOL;
48}
49

PHP 8のGeneratorクラスにおけるcurrentメソッドについて解説します。currentメソッドは、ジェネレータが現在指している値を返します。ジェネレータは、yieldキーワードを使って値を順番に生成する特別な関数です。

サンプルコードでは、指定された年月の全ての日付をDateTimeImmutableオブジェクトとして生成するgenerateDatesOfMonth関数を定義しています。この関数は、yieldを使って日付を一つずつ返します。

ジェネレータから値を取り出すには、通常foreachループを使用します。foreachループは、内部で自動的にジェネレータのcurrentメソッドを呼び出し、現在の値を処理します。

サンプルコードの後半部分では、currentメソッドを直接使用する例を示しています。まず、rewindメソッドでジェネレータを初期位置に戻しています。これは、ジェネレータが既に最後まで進んでいる場合に、最初の要素から再度アクセスできるようにするためです。その後、$dateGenerator->current()を呼び出すことで、ジェネレータが指す最初のDateTimeImmutableオブジェクトを取得し、フォーマットして表示しています。

currentメソッドは引数を取りません。戻り値はmixed型であり、ジェネレータが現在指している値を返します。ジェネレータが空の場合や、rewindやnextで終端を超えた場合にはNULLを返します。currentメソッドを使用することで、ジェネレータの現在の状態を直接的に確認することができます。foreach文で暗黙的に使用されることが多いですが、ジェネレータの状態を細かく制御したい場合に役立ちます。

Copy
1<?php
2
3/**
4 * Generator::current() の使用例
5 */
6
7function numberGenerator(int $start, int $end): Generator
8{
9  for ($i = $start; $i <= $end; $i++) {
10    yield $i;
11  }
12}
13
14$generator = numberGenerator(1, 3);
15
16// ジェネレータの現在の値を表示する
17echo $generator->current() . PHP_EOL; // 出力: 1
18
19$generator->next();
20
21// ジェネレータの次の値を表示する
22echo $generator->current() . PHP_EOL; // 出力: 2
23
24$generator->next();
25
26// ジェネレータの次の値を表示する
27echo $generator->current() . PHP_EOL; // 出力: 3
28
29$generator->next();
30
31// ジェネレータが完了した場合、current() は値を返さない
32var_dump($generator->current()); // 出力: bool(false)

PHP 8における Generator クラスの current() メソッドは、ジェネレータが現在指している値を返します。引数は必要ありません。戻り値は、ジェネレータが生成する値の型に応じて mixed 型となります。

このサンプルコードでは、numberGenerator というジェネレータ関数を定義しています。この関数は、指定された開始値から終了値までの数値を順番に生成します。

$generator = numberGenerator(1, 3); でジェネレータオブジェクトを作成し、$generator->current() を呼び出すことで、ジェネレータが最初に指している値（この場合は 1）を取得して表示しています。

$generator->next(); を呼び出すことで、ジェネレータの内部ポインタを次の値に進めます。その後、再度 $generator->current() を呼び出すと、次の値（この場合は 2、3）が表示されます。

ジェネレータがすべての値を生成し終えた後、つまり next() を呼び出してジェネレータが完了状態になった場合、current() は false を返します。var_dump($generator->current()); の出力結果から、この挙動を確認できます。

current() メソッドは、ジェネレータが現在どの値を生成しているかを確認する際に使用します。ジェネレータの内部ポインタを進める next() メソッドと組み合わせて使用することで、順番に値を処理できます。