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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 特定の拡張子を持つファイルのみをフィルタリングするイテレータ。
7 *
8 * SPLのFilterIteratorを継承し、accept()メソッドでフィルタリングの条件を定義します。
9 * このクラスは、与えられたイテレータ（例: DirectoryIterator）をラップし、
10 * 条件に一致する要素（ファイル）のみを返します。
11 */
12class NetworkFileFilter extends FilterIterator
13{
14    private string $extension;
15
16    /**
17     * コンストラクタ。
18     *
19     * @param Iterator $iterator フィルタリング対象のイテレータ
20     * @param string $extension 許可するファイルの拡張子（例: 'txt', 'log'）
21     */
22    public function __construct(Iterator $iterator, string $extension)
23    {
24        parent::__construct($iterator);
25        $this->extension = $extension;
26    }
27
28    /**
29     * 現在の要素がフィルタ条件を満たすか判定します。
30     *
31     * foreachループで要素が一つずつ評価される際に、このメソッドが呼び出されます。
32     * trueを返した要素のみがループの処理対象となります。
33     *
34     * @return bool 条件を満たす場合はtrue、それ以外はfalseを返します。
35     */
36    public function accept(): bool
37    {
38        // 元のイテレータから現在の要素（SplFileInfoオブジェクト）を取得します。
39        $file = $this->getInnerIterator()->current();
40
41        // それがファイルであり、かつ指定された拡張子を持つ場合のみ許可します。
42        if ($file instanceof SplFileInfo && $file->isFile() && $file->getExtension() === $this->extension) {
43            return true;
44        }
45
46        return false;
47    }
48}
49
50// --- メイン処理 ---
51
52// !!! 注意: アクセスしたいネットワークドライブのパスに書き換えてください !!!
53// WindowsのUNCパスの例: '\\\\server-name\\share\\folder'
54// Linux/macOSでマウントしたパスの例: '/mnt/network_share'
55$networkPath = '\\\\server-name\\share';
56
57// 検索したいファイルの拡張子
58$targetExtension = 'log';
59
60echo "ネットワークパス '{$networkPath}' 内の '.{$targetExtension}' ファイルを検索します...\n";
61
62try {
63    // ネットワークパス上のディレクトリを走査するためのイテレータを作成します。
64    // サブディレクトリも再帰的に検索します。
65    $iterator = new RecursiveIteratorIterator(
66        new RecursiveDirectoryIterator(
67            $networkPath,
68            RecursiveDirectoryIterator::SKIP_DOTS
69        )
70    );
71
72    // 作成したカスタムフィルタでイテレータをラップします。
73    $fileFilter = new NetworkFileFilter($iterator, $targetExtension);
74
75    // フィルタリングされた結果をforeachでループ処理します。
76    // このループが内部的にFilterIteratorの next() メソッドを呼び出し、
77    // accept()がtrueを返す次のファイルへと自動的に進めてくれます。
78    $foundCount = 0;
79    foreach ($fileFilter as $file) {
80        // SplFileInfoオブジェクトからフルパスを取得して表示します。
81        echo $file->getPathname() . "\n";
82        $foundCount++;
83    }
84
85    if ($foundCount === 0) {
86        echo "該当するファイルは見つかりませんでした。\n";
87    }
88} catch (UnexpectedValueException $e) {
89    // パスが存在しない、またはアクセス権がない場合のエラー処理
90    echo "\nエラー: パスにアクセスできませんでした。\n";
91    echo "詳細: {$e->getMessage()}\n";
92    echo "ヒント: \$networkPath の値が正しいか、ネットワーク接続やアクセス権を確認してください。\n";
93} catch (Exception $e) {
94    // その他の予期せぬエラー
95    echo "\n予期せぬエラーが発生しました: {$e->getMessage()}\n";
96}

このサンプルコードは、ネットワークドライブ上のフォルダを再帰的に検索し、指定した拡張子（この例では'.log'）を持つファイルのみを一覧表示するものです。PHP標準のFilterIteratorクラスを応用し、ファイル検索に独自のフィルタリング機能を追加しています。

このコードの核心部分は、foreachループがFilterIteratorをどのように扱うかにあります。foreachでフィルタがかかったファイルリストを一つずつ処理する際、PHPの内部では自動的にFilterIteratorのnext()メソッドが呼び出されます。

next()メソッドは引数を持たず、直接値を返すこともありません。その役割は、イテレータの内部ポインタを「次の有効な要素」へ進めることです。FilterIteratorの場合、next()は、カスタムクラスで定義されたaccept()メソッドがtrueを返す要素が見つかるまで、自動的に次の要素、そのまた次の要素へと内部的に移動し続けます。

この仕組みにより、開発者はフィルタリング条件を満たす要素だけをループ内で受け取ることができ、条件分岐を記述する手間を省いてコードを簡潔に保つことができます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 偶数のみをフィルタリングするカスタムイテレータ。
7 * FilterIteratorを継承し、フィルタリング条件を accept() メソッドに実装します。
8 */
9class EvenNumberFilter extends FilterIterator
10{
11    /**
12     * このメソッドは、現在の要素をイテレーションに含めるべきかどうかを判定します。
13     * trueを返した場合、その要素は有効とみなされます。
14     *
15     * @return bool
16     */
17    public function accept(): bool
18    {
19        // 親イテレータから現在の値を取得します。
20        $currentValue = $this->current();
21
22        // 値が整数で、かつ偶数であるかをチェックします。
23        return is_int($currentValue) && $currentValue % 2 === 0;
24    }
25}
26
27// 元となるデータ配列を作成します。
28$numbers = new ArrayIterator([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
29
30// カスタムフィルタクラスのインスタンスを生成します。
31$evenIterator = new EvenNumberFilter($numbers);
32
33// foreachループでイテレータを処理します。
34// このループの内部では、FilterIterator::next() メソッドが自動的に呼び出されます。
35// next() は、accept() が true を返す次の要素が見つかるまで、
36// 内部的にイテレータのポインタを進めます。
37foreach ($evenIterator as $evenNumber) {
38    echo $evenNumber . PHP_EOL;
39}

PHPのFilterIterator::next()メソッドは、イテレータの内部ポインタを次の要素に進めるためのメソッドです。このメソッドは引数を取らず、値を返しません。その役割は、イテレータの内部状態を更新することに特化しています。

FilterIteratorにおけるnext()の重要な点は、単にポインタを一つ進めるだけでなく、accept()メソッドで定義された条件を満たす次の有効な要素が見つかるまで、内部的にポインタを進め続けることです。

サンプルコードのforeachループでは、このnext()メソッドが各反復処理の最後で自動的に呼び出されます。例えば、2が出力された後、next()メソッドが実行されると、内部のイテレータは3をスキップし、accept()メソッドがtrueを返す次の偶数である4で停止します。この動作により、foreachループでは条件に合致する要素（この例では偶数）だけが取り出され、コードが簡潔になります。このようにnext()は、フィルタリング処理の核心的な役割を担っています。