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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * このスクリプトは、カレントディレクトリ内のファイルとディレクトリの一覧を表示します。
7 *
8 * DirectoryIteratorをIteratorIteratorでラップし、current()メソッドを使用して
9 * ディレクトリ内の各エントリ（ファイルやサブディレクトリ）を一つずつ取得する
10 * 具体的な方法を示します。
11 */
12
13// このスクリプトファイルが存在するディレクトリ（カレントディレクトリ）のパスを取得
14$directoryPath = __DIR__;
15
16echo "Contents of '{$directoryPath}':" . PHP_EOL;
17echo '----------------------------------' . PHP_EOL;
18
19try {
20    // 1. DirectoryIterator: 指定されたディレクトリを走査するためのイテレータを準備
21    $directoryIterator = new DirectoryIterator($directoryPath);
22
23    // 2. IteratorIterator: 既存のイテレータ(DirectoryIterator)をラップする
24    $iterator = new IteratorIterator($directoryIterator);
25
26    // 3. whileループでイテレータを明示的に操作
27    $iterator->rewind(); // イテレータを最初の位置にセット
28    while ($iterator->valid()) { // valid(): 現在位置に有効な要素があるか確認
29
30        // 4. current(): イテレータの現在位置の要素を取得
31        // この例では、DirectoryIteratorオブジェクトが返される
32        $fileInfo = $iterator->current();
33
34        // '.' (カレント) と '..' (親) ディレクトリは表示しない
35        if (!$fileInfo->isDot()) {
36            $type = $fileInfo->isDir() ? 'Directory' : 'File';
37            // 取得したオブジェクトのメソッドを使い、ファイル名などを表示
38            echo sprintf('[%-9s] %s', $type, $fileInfo->getFilename()) . PHP_EOL;
39        }
40
41        $iterator->next(); // next(): イテレータを次の要素に進める
42    }
43} catch (Exception $e) {
44    // ディレクトリが存在しない、またはアクセス権がない場合のエラー処理
45    echo 'Error: ' . $e->getMessage() . PHP_EOL;
46}
47

このPHPスクリプトは、指定されたディレクトリ内にあるファイルやディレクトリの一覧を表示するものです。ここでは IteratorIterator クラスの current() メソッドの役割を解説します。

まず、DirectoryIteratorでディレクトリを操作するための準備を行い、それを IteratorIterator でラップ（包み込む）します。IteratorIterator は、PHPに存在する様々な繰り返し処理の仕組み（イテレータ）を、統一的なインターフェースで扱えるようにするクラスです。

while ループの中で、イテレータを明示的に操作しています。current() メソッドは、このイテレータが現在指し示している要素を取得する機能を持っています。このメソッドに引数は必要ありません。戻り値は mixed 型で、元のイテレータが指している要素そのものが返されます。このサンプルコードでは、$fileInfo 変数に、個々のファイルやディレクトリの情報を格納した DirectoryIterator オブジェクトが代入されます。

取得したオブジェクトのメソッドを利用して、それがファイルかディレクトリかの判別や名前の取得を行い、画面に表示しています。処理が終わると next() で次の要素に進み、ディレクトリ内の全要素を順番に処理していきます。

Copy
1<?php
2
3/**
4 * IteratorIterator::current() を使用して現在の月を取得するサンプルコード
5 *
6 * この関数は、今月から始まる12ヶ月の期間を表すイテレータを作成します。
7 * 次に、そのイテレータを IteratorIterator でラップし、current() メソッドを
8 * 呼び出して最初の要素（現在の月を表す DateTimeImmutable オブジェクト）を取得し、
9 * 月の番号を出力します。
10 */
11function displayCurrentMonthUsingIterator(): void
12{
13    // 不変のDateTimeオブジェクトで、今月の1日を基準点として設定します。
14    $startDate = new DateTimeImmutable('first day of this month');
15
16    // 1ヶ月間隔の期間を定義します。
17    $interval = new DateInterval('P1M');
18
19    // DatePeriod は Traversable なオブジェクトで、日付の繰り返しを表現します。
20    // ここでは、今月から12ヶ月分の期間を作成します。
21    $datePeriod = new DatePeriod($startDate, $interval, 11); // 開始日 + 11回の繰り返し = 12ヶ月
22
23    // DatePeriod オブジェクトを IteratorIterator でラップします。
24    $iterator = new IteratorIterator($datePeriod);
25
26    // current() メソッドは、イテレータの現在のポインタが指す要素を返します。
27    // 初期状態では、最初の要素（今月）を指しています。
28    $currentDateTime = $iterator->current();
29
30    // 取得した DateTimeImmutable オブジェクトから、月を2桁の数値形式で出力します。
31    // 例: 4月であれば "04" が出力されます。
32    echo '現在の月 (IteratorIterator::current() を使用): ' . $currentDateTime->format('m') . PHP_EOL;
33}
34
35// 関数を実行して結果を表示します。
36displayCurrentMonthUsingIterator();
37
38?>

このPHPサンプルコードは、IteratorIteratorクラスのcurrent()メソッドを使い、繰り返し処理が可能な一連の日付データから、現在位置の要素を取得する例を示しています。具体的には、今月から始まる12ヶ月間の日付データの中から、先頭の要素である「現在の月」を取り出して表示します。

current()メソッドは、イテレータの内部ポインタが指し示している現在の要素を返します。このメソッドに引数はありません。イテレータが作成された直後の初期状態では、ポインタは必ず最初の要素を指しています。

コードの流れとしては、まずDatePeriodクラスで今月から12ヶ月分の連続した日付データを作成します。次に、このDatePeriodオブジェクトをIteratorIteratorに渡して、外部から操作できるイテレータを生成します。ここで$iterator->current()を実行すると、イテレータの先頭要素、すなわち「今月」を表すDateTimeImmutableオブジェクトが返されます。戻り値のデータ型は、元のイテレータが持つ要素によって変わるためmixed型となります。最後に、取得したオブジェクトからformat('m')メソッドで月を2桁の数値として抽出し、画面に出力しています。