【PHP8.x】NoRewindIterator::current()メソッドの使い方

Copy
1<?php
2
3/**
4 * NoRewindIterator と current() メソッドを使用して、現在のディレクトリの内容を一度だけイテレートする例。
5 *
6 * NoRewindIterator は、ラップされたイテレータの rewind() メソッドが一度だけ呼び出されるようにします。
7 * これにより、イテレータのポインタが巻き戻されるのを防ぎます。
8 * current() メソッドは、ラップされたイテレータの現在の要素を返します。
9 *
10 * キーワード「php current directory」に沿って、DirectoryIterator を使用して現在のディレクトリを操作します。
11 */
12function iterateCurrentDirectoryWithNoRewind(): void
13{
14    // 現在のディレクトリのパスを指定します。'.' は実行中のスクリプトがあるディレクトリを指します。
15    $currentDirPath = '.';
16
17    echo "現在のディレクトリ ({$currentDirPath}) の内容を一度だけ処理します。\n\n";
18
19    try {
20        // DirectoryIterator は、指定されたディレクトリの各エントリを SplFileInfo オブジェクトとして提供します。
21        $directoryIterator = new DirectoryIterator($currentDirPath);
22
23        // NoRewindIterator で DirectoryIterator をラップします。
24        // これにより、一度イテレーションを開始すると、途中で最初に戻ることができなくなります。
25        $noRewindIterator = new NoRewindIterator($directoryIterator);
26
27        echo "--- ディレクトリ内容の最初の処理 ---" . PHP_EOL;
28        // NoRewindIterator を foreach ループで使用し、ディレクトリの内容を順に処理します。
29        foreach ($noRewindIterator as $item) {
30            // NoRewindIterator::current() メソッドは、ラップされたイテレータの現在の要素を返します。
31            // foreach ループの $item 変数と $noRewindIterator->current() は同じオブジェクトを指します。
32            $currentEntry = $noRewindIterator->current();
33
34            // 現在のエントリ（ファイルまたはディレクトリ）の名前とタイプを表示します。
35            $type = $currentEntry->isDir() ? "ディレクトリ" : "ファイル";
36            echo "  - {$currentEntry->getFilename()} (タイプ: {$type})" . PHP_EOL;
37        }
38        echo "--- 処理終了 ---" . PHP_EOL;
39
40        // NoRewindIterator の特性により、一度イテレーションを終えると巻き戻しができないため、
41        // 同じ NoRewindIterator オブジェクトで再度イテレーションを行っても何も処理されません。
42        echo "\n--- 二度目のイテレーションを試みます（何も出力されないはずです） ---" . PHP_EOL;
43        $reiterationCount = 0;
44        foreach ($noRewindIterator as $item) {
45            // このブロックは実行されません。
46            echo "  - {$item->getFilename()} (二度目)" . PHP_EOL;
47            $reiterationCount++;
48        }
49        echo "二度目のイテレーションで処理されたエントリ数: {$reiterationCount}" . PHP_EOL;
50        echo "--- 処理終了 ---" . PHP_EOL;
51
52    } catch (UnexpectedValueException $e) {
53        // 指定されたディレクトリが存在しない、またはアクセス権がない場合に発生します。
54        echo "エラー: ディレクトリ '{$currentDirPath}' にアクセスできません: " . $e->getMessage() . PHP_EOL;
55    } catch (Exception $e) {
56        // その他の予期せぬエラーを捕捉します。
57        echo "予期せぬエラー: " . $e->getMessage() . PHP_EOL;
58    }
59}
60
61// サンプル関数を実行します。
62iterateCurrentDirectoryWithNoRewind();

PHPのNoRewindIterator::current()メソッドは、その名のとおり、ラップしている（内包している）イテレータの現在位置の要素を返す役割を持ちます。NoRewindIteratorクラスは、イテレータが一度だけしか巻き戻し（リワインド）されないように制御する特殊なイテレータです。これにより、イテレーションを一度開始すると途中で最初に戻ることができず、データソースを一度だけ順に処理したい場合に特に有用です。

このサンプルコードでは、現在のディレクトリの内容を一度だけ読み込むためにDirectoryIteratorをNoRewindIteratorでラップしています。DirectoryIteratorは「php current directory」のキーワードの通り、指定されたディレクトリ内の各エントリ（ファイルやサブディレクトリ）をSplFileInfoオブジェクトとして提供します。foreachループでディレクトリの内容を順に処理する際、$noRewindIterator->current()を呼び出すことで、ループの現在の要素（SplFileInfoオブジェクト）を直接取得できます。このメソッドは引数を受け取らず、現在の要素をmixed型で返します。

一度NoRewindIteratorでのイテレーションが完了すると、巻き戻しができないという特性のため、同じNoRewindIteratorオブジェクトで再度イテレーションを試みても何も処理されません。current()メソッドは、この「一度きり」のイテレーションの中で、その時点の要素を正確に提供する役割を果たします。

Copy
1<?php
2
3/**
4 * NoRewindIterator::current() の使用例を示します。
5 * キーワード「php current month」に関連付け、現在の月の名前をイテレータから取得します。
6 */
7function getCurrentMonthNameUsingNoRewindIterator(): string
8{
9    // 1月から12月までの月名を定義した配列
10    $months = [
11        1 => 'January', 2 => 'February', 3 => 'March', 4 => 'April',
12        5 => 'May', 6 => 'June', 7 => 'July', 8 => 'August',
13        9 => 'September', 10 => 'October', 11 => 'November', 12 => 'December'
14    ];
15
16    // ArrayIterator を使用して、配列をイテレータとして扱います。
17    $arrayIterator = new ArrayIterator($months);
18
19    // 現在の月番号を取得します (例: 1 = 1月, 2 = 2月, ...)。
20    $currentMonthNumber = (int) date('n');
21
22    // ArrayIterator のポインタを現在の月番号の位置まで進めます。
23    // NoRewindIterator::current() は内部イテレータの現在位置の要素を返します。
24    while ($arrayIterator->key() !== $currentMonthNumber && $arrayIterator->valid()) {
25        $arrayIterator->next();
26    }
27
28    // ArrayIterator を NoRewindIterator でラップします。
29    // NoRewindIterator は、デコレートされたイテレータの巻き戻し操作 (rewind()) が
30    // 一度しか実行されないようにする特殊なイテレータです。
31    // ここでは主に current() メソッドの動作を確認するために使用します。
32    $noRewindIterator = new NoRewindIterator($arrayIterator);
33
34    // NoRewindIterator の current() メソッドを使って、現在の月の名前を取得します。
35    // これは内部の ArrayIterator の current() を呼び出し、現在のイテレータ要素を返します。
36    return $noRewindIterator->current();
37}
38
39// 関数を呼び出し、現在の月の名前を出力します。
40echo getCurrentMonthNameUsingNoRewindIterator() . PHP_EOL;
41

PHPのNoRewindIterator::current()メソッドは、このイテレータが内部に持っている他のイテレータ（内部イテレータ）が現在指し示している要素の値を取得するために使われます。このメソッドは引数を一切取りません。戻り値はmixed型で、内部イテレータが持つどのような型の要素でも返す可能性があります。NoRewindIteratorは、内部イテレータの巻き戻し操作（rewind()）を一度しか行わないという特殊な働きを持つイテレータです。

このサンプルコードでは、「php current month」というキーワードに関連付け、現在の月の名前をイテレータから取得する例を示しています。具体的には、まず1月から12月までの月名を配列で用意し、これをArrayIteratorとして扱います。次に、date('n')関数で現在の月番号を取得し、ArrayIteratorのポインタをその月番号に対応する位置まで進めます。この位置まで進んだArrayIteratorをNoRewindIteratorで包み込みます。そして、$noRewindIterator->current()を呼び出すことで、内部イテレータが指し示す現在の月の名前（例えば、1月であれば'January'）が取得され、結果として出力されます。このコードは、NoRewindIterator::current()が、ラップされたイテレータの現在位置の要素値を簡潔に取得する仕組みを理解するのに役立ちます。