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

Copy
1<?php
2
3/**
4 * ネットワークドライブ上の指定されたディレクトリを再帰的に探索し、
5 * 条件に一致するファイル（この例ではログファイル）を検索します。
6 *
7 * RecursiveFilterIteratorを継承したカスタムフィルタを使用して、
8 * ディレクトリツリーを走査しながらアイテムを絞り込みます。
9 * foreachループがイテレータを処理する際に、内部的にnext()メソッドが呼び出され、
10 * 次のファイルやディレクトリへと進んでいきます。
11 *
12 * @param string $networkPath 検索対象のネットワークパス (例: '\\\\server-name\\share')
13 * @return void
14 */
15function findLogFilesOnNetworkDrive(string $networkPath): void
16{
17    // ネットワークパスが存在し、アクセス可能かを確認します。
18    if (!is_dir($networkPath)) {
19        echo "エラー: パス '{$networkPath}' が見つからないか、アクセスできません。\n";
20        echo "ネットワークドライブが正しくマウントされているか、パスが正しいか確認してください。\n";
21        return;
22    }
23
24    echo "パス '{$networkPath}' 内のログファイル (.log) を検索しています...\n\n";
25
26    try {
27        // 1. ディレクトリを再帰的に走査するためのイテレータを準備
28        $directoryIterator = new RecursiveDirectoryIterator(
29            $networkPath,
30            FilesystemIterator::SKIP_DOTS | FilesystemIterator::FOLLOW_SYMLINKS
31        );
32
33        // 2. RecursiveFilterIterator を継承したフィルタを定義
34        //    このフィルタは、ディレクトリまたは拡張子が '.log' のファイルのみを許可します。
35        $logFilterIterator = new class($directoryIterator) extends RecursiveFilterIterator {
36            /**
37             * このメソッドが true を返したアイテムだけが結果に含まれます。
38             * @return bool
39             */
40            public function accept(): bool
41            {
42                // 現在のアイテムがディレクトリの場合、その中も探索するため常に許可
43                if ($this->current()->isDir()) {
44                    return true;
45                }
46                // 現在のアイテムがファイルの場合、拡張子が 'log' なら許可
47                return $this->current()->getExtension() === 'log';
48            }
49        };
50
51        // 3. フィルタリングされた再帰イテレータを、フラットなリストとして扱えるように設定
52        //    これにより、ネストされたディレクトリ構造を意識せずにループ処理できます。
53        $recursiveIterator = new RecursiveIteratorIterator($logFilterIterator, RecursiveIteratorIterator::SELF_FIRST);
54
55        // 4. ループ処理で条件に一致したファイルパスを出力
56        //    このforeach文が、イテレータの next() を内部で自動的に呼び出します。
57        $found = false;
58        foreach ($recursiveIterator as $fileInfo) {
59            if ($fileInfo->isFile()) {
60                echo $fileInfo->getPathname() . "\n";
61                $found = true;
62            }
63        }
64
65        if (!$found) {
66            echo "ログファイルは見つかりませんでした。\n";
67        }
68    } catch (Exception $e) {
69        // アクセス権限がないなどの理由で例外が発生した場合の処理
70        echo "エラーが発生しました: " . $e->getMessage() . "\n";
71    }
72}
73
74// --- 実行例 ---
75
76// !!! 注意 !!!
77// 以下のパスを、あなたの環境に存在するネットワークドライブのパスに書き換えてください。
78// Windows の UNC パス (\\server\share) を指定する場合、バックスラッシュをエスケープする必要があるため、
79// '\\\\server-name\\share-folder' のように記述します。
80$targetNetworkPath = '\\\\192.168.1.100\\public_share'; // 例: 実際のパスに置き換えてください
81
82// 関数を呼び出してファイル検索を実行
83findLogFilesOnNetworkDrive($targetNetworkPath);

RecursiveFilterIteratorクラスに属するnext()メソッドは、イテレータの内部ポインタを次の要素に進める役割を担います。このメソッドは引数を取らず、戻り値もありません。その目的は、値を返すことではなく、イテレータの状態を更新することにあります。

サンプルコードでは、ネットワークドライブ上のファイルを再帰的に探索するためにforeachループが使われています。このforeachループがイテレータを処理する際に、next()メソッドがPHPによって内部的かつ自動的に呼び出されます。ループの各処理が完了すると、next()が実行され、次のファイルやディレクトリへと移動します。その際、accept()メソッドで定義されたフィルタリング条件を満たす、次の有効な要素が見つかるまで探索が進みます。

このように、next()メソッドはforeach文のような繰り返し構文を裏側で支える重要な機能です。プログラマがこのメソッドを直接呼び出す必要はなく、PHPが透過的に処理してくれるため、直感的なコードで複雑なファイル探索を実現できます。

Copy
1<?php
2
3/**
4 * 特定の拡張子を持つファイルのみをフィルタリングするカスタムイテレータクラス。
5 *
6 * この例では、Next.js プロジェクトのファイル構造を模した多次元配列から、
7 * 拡張子が '.js' または '.jsx' のファイルのみを再帰的に抽出します。
8 * RecursiveFilterIterator を継承し、accept() メソッドでフィルタ条件を定義します。
9 */
10class JsFileFilter extends RecursiveFilterIterator
11{
12    /**
13     * イテレータの現在の要素をフィルタリングします。
14     *
15     * @return bool 現在の要素をイテレーションに含める場合は true、除外する場合は false。
16     */
17    public function accept(): bool
18    {
19        // hasChildren() メソッドで、現在の要素が子を持つか（ディレクトリか）を判定します。
20        // ディレクトリの場合は、その中をさらに探索するため、常に true を返します。
21        if ($this->hasChildren()) {
22            return true;
23        }
24
25        // current() メソッドで現在の要素（ファイル名）を取得します。
26        $filename = $this->current();
27
28        // ファイル名が '.js' または '.jsx' で終わるか判定します。
29        return str_ends_with($filename, '.js') || str_ends_with($filename, '.jsx');
30    }
31}
32
33// Next.js のプロジェクト構造を模した多次元配列を定義します。
34$projectStructure = [
35    'pages' => [
36        'index.jsx',
37        'about.js',
38        'api' => [
39            'hello.js',
40        ],
41    ],
42    'components' => [
43        'Header.jsx',
44        'Footer.jsx',
45    ],
46    'public' => [
47        'favicon.ico',
48    ],
49    'styles' => [
50        'globals.css',
51    ],
52    'package.json',
53];
54
55// 配列を再帰的に走査するための RecursiveArrayIterator を作成します。
56$arrayIterator = new RecursiveArrayIterator($projectStructure);
57
58// カスタムフィルタ (JsFileFilter) を適用します。
59$filterIterator = new JsFileFilter($arrayIterator);
60
61// フィルタリングされた結果を再帰的にフラットに処理するための RecursiveIteratorIterator を作成します。
62$recursiveIterator = new RecursiveIteratorIterator($filterIterator);
63
64echo "プロジェクト内の JavaScript/JSX ファイル:\n";
65
66// foreach ループでフィルタリングされた要素を一つずつ処理します。
67// このループが実行されるたびに、内部的に next() メソッドが呼び出され、
68// イテレータのポインタが次の要素へ進みます。
69foreach ($recursiveIterator as $file) {
70    echo "- " . $file . PHP_EOL;
71}
72
73?>

このPHPサンプルコードは、再帰的なイテレータにフィルタを適用する RecursiveFilterIterator クラスと、その next メソッドの動作を示しています。next メソッドは、イテレータの内部ポインタを次の要素に進める役割を持ちます。このメソッドは引数を取らず、戻り値もありません。通常、foreach ループなどでイテレータを処理する際に、PHPエンジンによって内部的に自動で呼び出されるため、開発者が直接記述することは稀です。

このコードでは、まず RecursiveFilterIterator を継承した JsFileFilter クラスを定義しています。これは、Next.jsのプロジェクト構造を模した多次元配列から、拡張子が .js または .jsx のファイルのみを抽出するためのカスタムフィルタです。accept メソッドでフィルタリングの条件を定義しており、条件に合わない要素はスキップされます。

foreach ループが実行される際、ループの各反復の終わりに next メソッドが呼び出されます。next メソッドは、accept メソッドが true を返す次の要素が見つかるまで、内部ポインタを進め続けます。その結果、フィルタリング条件を満たしたJavaScript関連のファイル名だけが順に出力されます。このように next メソッドは、フィルタリング処理において要素を次に進めるという重要な役割を担っています。