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

Copy
1<?php
2
3// このサンプルコードは、RecursiveIterator インターフェースの current() メソッドの基本的な使い方を示します。
4// current() メソッドは、イテレータが現在指している要素を返します。
5
6/**
7 * RecursiveIterator::current() メソッドのサンプル
8 *
9 * この関数は、ファイルシステムを再帰的に走査し、各要素（ファイル）に対して
10 * current() メソッドを呼び出し、その情報を表示します。
11 * RecursiveDirectoryIterator は RecursiveIterator インターフェースの実装の一つです。
12 */
13function demonstrateRecursiveIteratorCurrent(): void
14{
15    // 一時的なテストディレクトリとファイルを準備します。
16    // uniqid() を使用して、ディレクトリ名が重複しないようにします。
17    $testDir = __DIR__ . '/recursive_iterator_test_dir_' . uniqid();
18    if (!is_dir($testDir)) {
19        mkdir($testDir, 0777, true);
20    }
21    file_put_contents($testDir . '/file1.txt', 'Content of file1');
22    mkdir($testDir . '/subdir', 0777, true);
23    file_put_contents($testDir . '/subdir/file2.txt', 'Content of file2');
24
25    try {
26        // 1. RecursiveDirectoryIterator をインスタンス化します。
27        //    これは指定されたディレクトリ（$testDir）を走査するためのイテレータです。
28        //    RecursiveDirectoryIterator::SKIP_DOTS フラグは、'.' と '..' エントリをスキップします。
29        $directoryIterator = new RecursiveDirectoryIterator($testDir, RecursiveDirectoryIterator::SKIP_DOTS);
30
31        // 2. RecursiveIteratorIterator をインスタンス化します。
32        //    これは RecursiveIterator を受け取り、再帰的な走査を可能にする特別なイテレータです。
33        //    RecursiveIteratorIterator::LEAVES_ONLY は、ディレクトリ自体ではなく、
34        //    最終的なファイル（「葉ノード」）のみを走査対象とします。
35        $recursiveIterator = new RecursiveIteratorIterator($directoryIterator, RecursiveIteratorIterator::LEAVES_ONLY);
36
37        echo "--- RecursiveIterator::current() メソッドのデモンストレーション ---\n\n";
38
39        // 3. foreach ループでイテレータを走査します。
40        foreach ($recursiveIterator as $name => $fileInfo) {
41            // current() メソッドを呼び出して、イテレータが現在指している要素を取得します。
42            // この場合、foreach ループの $fileInfo 変数と $currentElement は、
43            // 同じ SplFileInfo オブジェクトを指します。
44            $currentElement = $recursiveIterator->current();
45
46            // 取得した要素の情報を表示します。
47            echo "現在の要素 (current() 経由):\n";
48            echo "  パス: " . $currentElement->getPathname() . "\n";
49            echo "  ファイル名: " . $currentElement->getFilename() . "\n";
50            echo "  タイプ: " . ($currentElement->isFile() ? "ファイル" : "ディレクトリ") . "\n";
51            echo "----------------------------------------\n";
52        }
53
54    } catch (UnexpectedValueException $e) {
55        // ディレクトリが存在しない、またはアクセスできない場合のエラーハンドリング
56        echo "エラー: ディレクトリの操作中に問題が発生しました: " . $e->getMessage() . "\n";
57    } finally {
58        // 作成した一時ディレクトリとファイルをクリーンアップ（削除）します。
59        if (is_dir($testDir)) {
60            $it = new RecursiveDirectoryIterator($testDir, RecursiveDirectoryIterator::SKIP_DOTS);
61            $files = new RecursiveIteratorIterator($it, RecursiveIteratorIterator::CHILD_FIRST);
62            foreach ($files as $file) {
63                if ($file->isDir()) {
64                    rmdir($file->getRealPath());
65                } else {
66                    unlink($file->getRealPath());
67                }
68            }
69            rmdir($testDir);
70        }
71        echo "\nテストディレクトリをクリーンアップしました。\n";
72    }
73}
74
75// デモンストレーション関数を実行します。
76demonstrateRecursiveIteratorCurrent();
77

PHP 8のRecursiveIteratorインターフェースが提供するcurrent()メソッドは、イテレータが現在指している要素を取得するために使用されます。このメソッドは引数を一切取らず、mixed型の戻り値として、イテレータのポインタが指す現在の要素を返します。例えば、ファイルシステムを再帰的に走査するRecursiveDirectoryIteratorを使用している場合、current()は現在のファイルやディレクトリの情報を格納したSplFileInfoオブジェクトを返します。

RecursiveIteratorは、ディレクトリ構造のような再帰的なデータ構造を効率的に走査するためのインターフェースです。current()メソッドは、この再帰的な走査中に「今、どこにいるか」を示す、現在の要素のデータそのものを取得する役割を担います。

サンプルコードでは、RecursiveDirectoryIteratorとRecursiveIteratorIteratorを用いてファイルシステムを再帰的に走査しています。foreachループ内で$recursiveIterator->current()を呼び出すことで、現在のファイル情報を格納したSplFileInfoオブジェクトを明示的に取得し、そのパスやファイル名などの詳細な情報を表示しています。foreachループの変数も現在の要素を指しますが、current()を直接呼び出すことで、現在の要素にアクセスする基本的な方法を示しています。PHP 8の安定版で利用可能なこのcurrent()メソッドは、再帰的なデータ走査において現在位置のデータにアクセスする上で、不可欠な基本的な手段となります。

Copy
1<?php
2
3/**
4 * RecursiveIterator::current() メソッドの利用例を示します。
5 *
6 * この関数は、指定されたディレクトリとそのサブディレクトリ内を再帰的に走査し、
7 * 見つかった各ファイルやディレクトリのパスを表示します。
8 * RecursiveIterator::current() は、イテレータが現在指している要素（ここではファイルやディレクトリ）を返します。
9 *
10 * @param string $directoryPath 走査を開始するディレクトリのパス。
11 * @return void
12 */
13function demonstrateRecursiveIteratorCurrent(string $directoryPath): void
14{
15    // 指定されたパスが有効なディレクトリであるかを確認します。
16    if (!is_dir($directoryPath)) {
17        echo "エラー: 指定されたディレクトリ '{$directoryPath}' が見つからないか、有効ではありません。\n";
18        return;
19    }
20
21    echo "--- ディレクトリ '{$directoryPath}' の内容を再帰的に走査します ---\n";
22
23    try {
24        // 1. RecursiveDirectoryIterator の作成
25        //    これは、指定されたディレクトリ（$directoryPath）とそのサブディレクトリを
26        //    再帰的に探索するための基礎となるイテレータです。
27        //    RecursiveDirectoryIterator::SKIP_DOTS フラグは、'.'（現在のディレクトリ）と
28        //    '..'（親ディレクトリ）のエントリをスキップするために使われます。
29        $directoryIterator = new RecursiveDirectoryIterator(
30            $directoryPath,
31            RecursiveDirectoryIterator::SKIP_DOTS
32        );
33
34        // 2. RecursiveIteratorIterator の作成
35        //    RecursiveDirectoryIterator はそれ自体が再帰的な構造を持っていますが、
36        //    これを通常の foreach ループで簡単に扱えるようにするために、
37        //    RecursiveIteratorIterator で「平坦化」します。
38        //    これにより、ネストされたディレクトリ構造を気にすることなく、
39        //    すべてのファイルやディレクトリを順次処理できるようになります。
40        //    RecursiveIteratorIterator::LEAVES_ONLY フラグは、
41        //    ディレクトリ自体ではなく、最終的なファイル（葉）のみを処理対象とします。
42        //    もしディレクトリ自体もリストに含めたい場合は、このフラグを削除するか、
43        //    RecursiveIteratorIterator::SELF_FIRST を使用します。
44        $recursiveIterator = new RecursiveIteratorIterator(
45            $directoryIterator,
46            RecursiveIteratorIterator::LEAVES_ONLY
47        );
48
49        // 3. イテレータのループ処理と current() メソッドの使用
50        //    foreach ループを使って、$recursiveIterator の各要素を順番に処理します。
51        //    このループの各ステップで、$recursiveIterator は次のファイルまたはディレクトリを指します。
52        foreach ($recursiveIterator as $fileInfo) {
53            // RecursiveIterator::current() メソッドは、
54            // 現在イテレータが指している「要素の値」を返します。
55            // RecursiveDirectoryIterator と RecursiveIteratorIterator の場合、
56            // このメソッドは SplFileInfo クラスのオブジェクトを返します。
57            // SplFileInfo オブジェクトには、ファイル名、パス、サイズなど、
58            // ファイルに関する様々な情報が含まれています。
59            // ここでは、getPathname() メソッドを使って、ファイルまたはディレクトリの
60            // 完全なパスを取得しています。
61            echo $fileInfo->getPathname() . "\n";
62        }
63    } catch (UnexpectedValueException $e) {
64        // ディレクトリへのアクセス権がない、またはパスが無効な場合などに発生する例外を捕捉します。
65        echo "エラー: ディレクトリ '{$directoryPath}' の走査中に問題が発生しました。\n";
66        echo "詳細: " . $e->getMessage() . "\n";
67    }
68
69    echo "--- 走査完了 ---\n";
70}
71
72// このスクリプトが実行されている現在のディレクトリを対象とします。
73// PHP の組み込み定数 __DIR__ は、現在のスクリプトがあるディレクトリのフルパスを返します。
74$currentScriptDirectory = __DIR__;
75
76// 定義した関数を実行し、RecursiveIterator::current() の動作を確認します。
77demonstrateRecursiveIteratorCurrent($currentScriptDirectory);

PHP 8のRecursiveIterator::current()メソッドは、イテレータが現在指し示している要素の「値」を返すために使用されます。引数はなく、戻り値はmixed型で、イテレータの種類によって異なるデータ型を返します。

このサンプルコードでは、指定したディレクトリとそのサブディレクトリにあるすべてのファイルやディレクトリを再帰的に探し出し、そのパスを表示する例を示しています。RecursiveDirectoryIteratorとRecursiveIteratorIteratorを組み合わせることで、複雑な再帰処理を簡潔に実現しています。

foreachループを使ってイテレータを順に処理する際、ループの各ステップでRecursiveIterator::current()が暗黙的に呼び出され、現在指している要素を取得しています。この例では、ファイルやディレクトリに関する詳細情報を持つSplFileInfoオブジェクトが返されます。このオブジェクトからgetPathname()メソッドを使って、ファイルやディレクトリの完全なパスを取得し、画面に表示しています。これにより、ディレクトリ構造を意識することなく、一つ一つの要素を処理できる点が特徴です。