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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * CachingIterator::current() を使用して現在のディレクトリ内の項目を一覧表示します。
7 *
8 * この関数は、現在のスクリプトファイルが存在するディレクトリの内容を読み取り、
9 * CachingIterator を通じて各項目（ファイルやディレクトリ）の名前を表示します。
10 */
11function displayCurrentDirectoryItems(): void
12{
13    try {
14        // DirectoryIterator を使用して、現在のディレクトリ (__DIR__) を開きます。
15        $directoryIterator = new DirectoryIterator(__DIR__);
16
17        // DirectoryIterator を CachingIterator でラップします。
18        // これにより、hasNext() のような追加機能が利用可能になります。
19        $cachingIterator = new CachingIterator($directoryIterator);
20
21        echo "現在のディレクトリ (" . __DIR__ . ") の内容:" . PHP_EOL;
22
23        // CachingIterator を foreach で反復処理します。
24        foreach ($cachingIterator as $item) {
25            // CachingIterator::current() は、反復処理中の現在の要素を返します。
26            // このループでは、変数 $item と同じ SplFileInfo オブジェクトが返されます。
27            $currentItem = $cachingIterator->current();
28
29            // '.' や '..' といった特殊なディレクトリは除外します。
30            if ($currentItem->isDot()) {
31                continue;
32            }
33
34            // 現在の項目がディレクトリかファイルかを判断して表示形式を変えます。
35            $type = $currentItem->isDir() ? 'ディレクトリ' : 'ファイル';
36            echo " - " . $currentItem->getFilename() . " ({$type})" . PHP_EOL;
37        }
38    } catch (Exception $e) {
39        // ディレクトリが読み取れない場合などのエラーを処理します。
40        echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
41    }
42}
43
44// 関数を実行して結果を表示します。
45displayCurrentDirectoryItems();

CachingIterator::current()メソッドは、foreachなどの繰り返し処理において、イテレータが現在指し示している要素を取得するメソッドです。

このメソッドは引数を取りません。戻り値は、現在処理対象となっている要素そのものです。元となるイテレータが何を扱うかによって返される値の型は変わるため、戻り値の型はmixedと定義されています。

サンプルコードは、現在のディレクトリ内にあるファイルやディレクトリを一覧表示するものです。はじめにDirectoryIteratorでディレクトリ情報を取得し、それをCachingIteratorで包み込んでいます。foreachループで各項目を順番に処理する中で、$cachingIterator->current()を呼び出すと、その時点でループが指している現在の項目が返されます。この例では、ファイルやディレクトリの情報を保持するSplFileInfoオブジェクトが返却されます。

通常、foreachループではループ変数（このコードでは$item）に現在の要素が自動的にセットされるため、current()を明示的に呼び出す必要は多くありません。しかし、このコードはcurrent()メソッドがどのように動作するかを明確に示しています。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * CachingIterator::current() を使用して今月のデータを検索するクラス
7 */
8class MonthlyDataProcessor
9{
10    /**
11     * @var array<string, string> 月ごとのサンプルデータ
12     */
13    private array $monthlyData;
14
15    public function __construct()
16    {
17        // サンプルデータとして、月名をキーとする連想配列を定義します
18        $this->monthlyData = [
19            'January'   => 'Task for January',
20            'February'  => 'Task for February',
21            'March'     => 'Task for March',
22            'April'     => 'Task for April',
23            'May'       => 'Task for May',
24            'June'      => 'Task for June',
25            'July'      => 'Task for July',
26            'August'    => 'Task for August',
27            'September' => 'Task for September',
28            'October'   => 'Task for October',
29            'November'  => 'Task for November',
30            'December'  => 'Task for December',
31        ];
32    }
33
34    /**
35     * 現在の月のデータをコンソールに表示します。
36     * CachingIterator::current() を使ってイテレータの現在の要素を取得します。
37     */
38    public function findAndDisplayCurrentMonthData(): void
39    {
40        // PHPのdate関数を使って、現在の月名（例: "October"）を取得します
41        $currentMonth = date('F');
42
43        // 配列からイテレータを作成し、それをCachingIteratorでラップします
44        // イテレータは、配列などの集合体を一つずつ順番に処理するための仕組みです
45        $arrayIterator = new ArrayIterator($this->monthlyData);
46        $cachingIterator = new CachingIterator($arrayIterator);
47
48        echo "Searching for data for the current month: {$currentMonth}" . PHP_EOL;
49        echo '---' . PHP_EOL;
50
51        // CachingIteratorをforeachでループ処理します
52        foreach ($cachingIterator as $month => $data) {
53            // CachingIterator::key() は現在のキー（このループでは変数 $month と同じ）を返します
54            $keyFromIterator = $cachingIterator->key();
55
56            // 現在のキーが、実行時の「今月」と一致するかどうかをチェックします
57            if ($keyFromIterator === $currentMonth) {
58                // CachingIterator::current() は現在の値（このループでは変数 $data と同じ）を返します。
59                // このメソッドを使って、現在の要素に明示的にアクセスできることを示します。
60                $valueFromIterator = $cachingIterator->current();
61
62                echo "Found a match!" . PHP_EOL;
63                echo "Month: {$keyFromIterator}" . PHP_EOL;
64                echo "Data: {$valueFromIterator}" . PHP_EOL;
65                
66                // データが見つかったので処理を終了します
67                return;
68            }
69        }
70
71        echo "No data found for {$currentMonth}." . PHP_EOL;
72    }
73}
74
75// クラスのインスタンスを作成します
76$processor = new MonthlyDataProcessor();
77
78// メソッドを実行して、現在の月のデータを表示します
79$processor->findAndDisplayCurrentMonthData();

このPHPコードは、CachingIterator::current()メソッドの具体的な使用例を示しています。月ごとのタスクが格納されたデータの中から、現在の月のタスクを検索して表示する処理を行います。

CachingIteratorは、配列のような集合データを一つずつ順番に処理するための仕組みである「イテレータ」を拡張したものです。

findAndDisplayCurrentMonthDataメソッドでは、まずPHPのdate関数で現在の月名を取得します。次に、月ごとのデータを持つ配列を元にCachingIteratorのインスタンスを生成します。

foreachループで全ての月を順番にチェックしていく中で、$cachingIterator->current()メソッドが呼び出されています。このメソッドは引数を取らず、イテレータが現在指し示している要素の「値」（この例ではタスク内容の文字列）を返します。戻り値の型は、元のデータによって様々であるためmixed型となります。

このサンプルコードでは、foreachループによって変数$dataに自動的に代入される値と、$cachingIterator->current()が返す値は全く同じです。このメソッドを使うことで、ループ処理の最中に、イテレータが指している現在の値を明示的に取得できることを示しています。