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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * ネットワークドライブ上の指定されたパスを再帰的にスキャンし、
7 * ファイルとディレクトリの一覧を表示します。
8 *
9 * この関数は内部で RecursiveIteratorIterator を使用します。
10 * foreach ループが各要素を処理する際に、イテレータの next() メソッドが
11 * 暗黙的に呼び出され、次のファイル/ディレクトリへと移動します。
12 *
13 * @param string $path スキャンするネットワークドライブのパス (例: '\\\\server\\share' or '/mnt/share')
14 * @return void
15 */
16function listNetworkDriveFiles(string $path): void
17{
18    // 指定されたパスが存在し、アクセス可能かを確認
19    if (!is_dir($path)) {
20        echo "エラー: パスが見つからないか、ディレクトリではありません: " . $path . PHP_EOL;
21        return;
22    }
23
24    echo "スキャンを開始します: " . $path . PHP_EOL;
25    echo "-----------------------------------------" . PHP_EOL;
26
27    try {
28        // 指定されたパスから再帰的なディレクトリイテレータを作成します。
29        // SKIP_DOTSは '.' や '..' をスキップするためのオプションです。
30        $directoryIterator = new RecursiveDirectoryIterator(
31            $path,
32            FilesystemIterator::SKIP_DOTS
33        );
34
35        // 再帰的なイテレータをフラットに（直線的に）扱えるようにラップします。
36        $iterator = new RecursiveIteratorIterator(
37            $directoryIterator,
38            RecursiveIteratorIterator::SELF_FIRST
39        );
40
41        // foreach ループで全てのファイルとディレクトリを順に処理します。
42        // このループの各繰り返しにおいて、内部的に $iterator->next() が呼び出され、
43        // イテレータが次の要素へと進みます。
44        foreach ($iterator as $fileinfo) {
45            echo $fileinfo->getPathname() . PHP_EOL;
46        }
47
48    } catch (UnexpectedValueException $e) {
49        // アクセス権がないなどの理由でスキャンに失敗した場合のエラーハンドリング
50        echo "エラー: ディレクトリのスキャン中に問題が発生しました。" . PHP_EOL;
51        echo "詳細: " . $e->getMessage() . PHP_EOL;
52    } finally {
53        echo "-----------------------------------------" . PHP_EOL;
54        echo "スキャンが完了しました。" . PHP_EOL;
55    }
56}
57
58// --- 実行例 ---
59// 以下のパスを、ご自身の環境に合わせてアクセス可能なネットワークドライブのパスに書き換えてください。
60
61// 例: Windows の共有フォルダ (UNCパス)
62// $networkDrivePath = '\\\\SERVER_NAME\\SharedFolder';
63
64// 例: Linux や macOS でマウントした共有フォルダ
65// $networkDrivePath = '/mnt/network_share';
66
67// このサンプルコードを単体で動作確認できるよう、カレントディレクトリを対象とします。
68$networkDrivePath = __DIR__;
69
70// 関数を実行
71listNetworkDriveFiles($networkDrivePath);

RecursiveIteratorIteratorクラスのnext()メソッドは、イテレータ（繰り返し処理を行うための道具）を次の要素へ進める役割を担います。このメソッドは引数を受け取らず、何かを返す（戻り値）こともありません。その目的は、イテレータの内部的な位置を一つ次に移動させるという操作そのものだからです。

サンプルコードでは、指定されたディレクトリ内のファイルやフォルダを、深い階層まで含めて全て一覧表示しています。RecursiveIteratorIteratorは、このような階層構造を持つデータを、先頭から順番に処理できる平坦なリストのように見せる機能を提供します。

コードの中心であるforeachループで$iteratorを処理する際、このnext()メソッドが重要な役割を果たします。ループが一回終わるごとに、PHPの内部で自動的に$iterator->next()が呼び出され、処理対象が次のファイルやディレクトリへと移動します。このように、開発者が意識してnext()メソッドを呼び出さなくても、foreach文を使うだけで、複雑なディレクトリ構造内の全要素を簡単に、そして漏れなくたどることが可能になります。

Copy
1<?php
2
3/**
4 * RecursiveIteratorIterator::next() の動作を実演します。
5 *
6 * Next.jsのファイルシステムベースのルーティングのように、
7 * 階層化されたディレクトリ構造を再帰的にスキャンする例です。
8 * foreachループは内部で自動的に next() を呼び出しますが、
9 * このサンプルでは while ループを使い、イテレータの各メソッド
10 * (valid, current, next) を明示的に呼び出すことで、
11 * next() がどのように機能するかを分かりやすく示します。
12 */
13function demonstrateRecursiveIteratorNext(): void
14{
15    // --- 準備: サンプル用のディレクトリとファイルを一時的に作成 ---
16    $baseDir = 'temp_pages_for_iterator';
17    // 既存のディレクトリがあれば削除してクリーンな状態にする
18    if (is_dir($baseDir)) {
19        // このヘルパー関数はサンプルコードの下部に定義されています
20        removeDirectoryRecursively($baseDir);
21    }
22    mkdir($baseDir . '/api', 0777, true);
23    touch($baseDir . '/index.php');
24    touch($baseDir . '/about.php');
25    touch($baseDir . '/api/users.php');
26
27    echo "--- ディレクトリのスキャンを開始 ---\n";
28
29    try {
30        // 1. ディレクトリを再帰的に走査するためのイテレータを作成
31        $directoryIterator = new RecursiveDirectoryIterator(
32            $baseDir,
33            FilesystemIterator::SKIP_DOTS
34        );
35
36        // 2. RecursiveIteratorをフラットなリストとして扱うためのイテレータでラップ
37        $iterator = new RecursiveIteratorIterator($directoryIterator);
38
39        // 3. whileループでイテレータを手動で操作
40        // イテレータを最初の要素にセット
41        $iterator->rewind();
42
43        while ($iterator->valid()) { // valid(): 現在位置に有効な要素があるか確認
44            // current(): 現在の要素(SplFileInfoオブジェクト)を取得
45            echo $iterator->current()->getPathname() . "\n";
46
47            // next(): イテレータを次の要素に進める。これがこのサンプルの中心。
48            // これがないと、ループは最初の要素で停止し、無限ループになります。
49            $iterator->next();
50        }
51    } finally {
52        // --- 後片付け: 作成した一時ディレクトリとファイルを削除 ---
53        removeDirectoryRecursively($baseDir);
54        echo "--- 一時ディレクトリをクリーンアップしました ---\n";
55    }
56}
57
58/**
59 * 指定されたディレクトリを再帰的に削除するヘルパー関数。
60 * このサンプルコードを単体で安全に実行するために使用します。
61 *
62 * @param string $dir 削除するディレクトリのパス
63 * @return void
64 */
65function removeDirectoryRecursively(string $dir): void
66{
67    if (!is_dir($dir)) {
68        return;
69    }
70    $files = new RecursiveIteratorIterator(
71        new RecursiveDirectoryIterator($dir, FilesystemIterator::SKIP_DOTS),
72        RecursiveIteratorIterator::CHILD_FIRST
73    );
74
75    foreach ($files as $fileinfo) {
76        $action = ($fileinfo->isDir() ? 'rmdir' : 'unlink');
77        $action($fileinfo->getRealPath());
78    }
79    rmdir($dir);
80}
81
82// 作成した関数を実行します
83demonstrateRecursiveIteratorNext();

RecursiveIteratorIterator::next()は、イテレータが指し示している内部的な位置を、次の要素へ一つ進めるためのメソッドです。このメソッドは引数を受け取らず、何か特定の値を返す（戻り値）こともありません。その役割は、イテレータの状態を更新することに特化しています。

サンプルコードでは、階層化されたディレクトリ内のファイルやフォルダを順番に処理する例を示しています。通常foreachループを使えばPHPが自動的にイテレータを次に進めてくれますが、このコードではwhileループを使い、その仕組みを明示的に再現しています。

ループの中では、まずvalid()メソッドで現在の位置に有効な要素が存在するかを確認します。次にcurrent()メソッドでその要素（ファイル情報など）を取得して表示します。そして最後にnext()メソッドを呼び出すことで、イテレータを次のファイルやフォルダに進めています。もしこのnext()の呼び出しを忘れると、イテレータは最初の要素を指したままとなり、ループが終了しない「無限ループ」の状態に陥ってしまいます。このようにnext()は、イテレータを一つずつ正しく進めていくために不可欠な操作です。