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

Copy
1<?php
2
3/**
4 * RecursiveDirectoryIterator::isFile() メソッドの動作を示すサンプルコードです。
5 *
6 * このコードを実行する前に、以下のディレクトリとファイルを手動で作成してください。
7 * (例: このスクリプトと同じディレクトリに `test_dir` を作成)
8 *
9 * [スクリプトがあるディレクトリ]/test_dir/
10 * [スクリプトがあるディレクトリ]/test_dir/file1.txt
11 * [スクリプトがあるディレクトリ]/test_dir/subdir/
12 * [スクリプトがあるディレクトリ]/test_dir/subdir/file2.txt
13 * [スクリプトがあるディレクトリ]/test_dir/subdir/empty_dir/
14 */
15function demonstrateRecursiveDirectoryIsFile(): void
16{
17    // サンプルを実行する対象ディレクトリのパスを設定します。
18    // スクリプトと同じディレクトリにある 'test_dir' を指定します。
19    $targetDirectory = __DIR__ . '/test_dir';
20
21    // 指定されたディレクトリが存在しない場合は、実行を停止しメッセージを表示します。
22    if (!is_dir($targetDirectory)) {
23        echo "エラー: 指定されたディレクトリ '{$targetDirectory}' が見つかりません。\n";
24        echo "サンプルコードのコメントに従って、ディレクトリとファイルを作成してください。\n";
25        return;
26    }
27
28    echo "--- RecursiveDirectoryIterator::isFile() のデモンストレーション ---\n";
29    echo "対象ディレクトリ: {$targetDirectory}\n\n";
30
31    try {
32        // RecursiveDirectoryIterator は、指定されたディレクトリの内容をイテレートします。
33        // RecursiveDirectoryIterator::SKIP_DOTS フラグは、'.' と '..' エントリをスキップするために使用します。
34        $directoryIterator = new RecursiveDirectoryIterator(
35            $targetDirectory,
36            RecursiveDirectoryIterator::SKIP_DOTS
37        );
38
39        // RecursiveIteratorIterator は、RecursiveDirectoryIterator と組み合わせて
40        // ディレクトリツリー全体を再帰的に走査するために使用します。
41        // RecursiveIteratorIterator::SELF_FIRST は、ディレクトリ自体をその内容の前にイテレートすることを意味します。
42        $recursiveIterator = new RecursiveIteratorIterator(
43            $directoryIterator,
44            RecursiveIteratorIterator::SELF_FIRST
45        );
46
47        // ディレクトリツリー内の各要素をループします。
48        // $fileInfo は SplFileInfo のインスタンスです。
49        foreach ($recursiveIterator as $fileInfo) {
50            // RecursiveDirectoryIterator (またはその親クラスである SplFileInfo) の
51            // isFile() メソッドを使用して、現在の要素が通常のファイルであるかを確認します。
52            if ($fileInfo->isFile()) {
53                echo "[ファイル] " . $fileInfo->getPathname() . "\n";
54            } elseif ($fileInfo->isDir()) {
55                // isFile() が false で、かつ isDir() が true の場合はディレクトリです。
56                echo "[ディレクトリ] " . $fileInfo->getPathname() . "\n";
57            } else {
58                // それ以外の要素 (シンボリックリンクなど)
59                echo "[その他] " . $fileInfo->getPathname() . "\n";
60            }
61        }
62    } catch (UnexpectedValueException $e) {
63        // パスがディレクトリではない、またはアクセス権がない場合などに発生する可能性があります。
64        echo "エラー: ディレクトリの読み込み中に問題が発生しました: " . $e->getMessage() . "\n";
65    } catch (Exception $e) {
66        // その他の予期せぬエラーを捕捉します。
67        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
68    }
69}
70
71// デモンストレーション関数を実行します。
72demonstrateRecursiveDirectoryIsFile();

PHP 8のRecursiveDirectoryIterator::isFile()メソッドは、ファイルシステムを再帰的に走査する際に、現在処理している要素が「通常のファイル」であるかどうかを判定するために使用されます。このメソッドは引数を取らず、判定結果を真偽値（bool）で返します。通常のファイルであればtrueを、ディレクトリやシンボリックリンクなど、通常のファイルでない場合はfalseを返します。

サンプルコードでは、RecursiveDirectoryIteratorとRecursiveIteratorIteratorを組み合わせて、指定されたディレクトリツリー内のすべてのファイルやディレクトリを順に処理しています。各要素についてisFile()メソッドを呼び出し、その戻り値に応じて「[ファイル]」または「[ディレクトリ]」として表示を切り替えています。例えば、test_dir/file1.txtのようなファイルに対してはisFile()がtrueを返し、「[ファイル]」として認識されます。一方、test_dir/subdir/のようなディレクトリに対してはfalseを返すため、isDir()メソッドと組み合わせてディレクトリとして扱われます。このように、isFile()メソッドを用いることで、複雑なファイル構造を持つディレクトリの中から特定のファイルだけを抽出し、処理を行うといった操作が容易になります。

Copy
1<?php
2
3/**
4 * 指定されたディレクトリとそのサブディレクトリ内のすべてのファイルを検索し、表示します。
5 * RecursiveDirectoryIterator を用いてディレクトリを再帰的に走査し、
6 * isFile() メソッドで各要素がファイルであるかを確認する例です。
7 *
8 * @param string $path 走査を開始するディレクトリのパス
9 * @return void
10 */
11function findFilesInDirectory(string $path): void
12{
13    echo "ディレクトリ '{$path}' 内のファイルを検索中...\n";
14
15    try {
16        // RecursiveDirectoryIterator を初期化します。
17        // これにより、指定されたパスのディレクトリとファイルにアクセスできるようになります。
18        $directoryIterator = new RecursiveDirectoryIterator($path);
19
20        // RecursiveIteratorIterator を使用して、ディレクトリを再帰的に（サブディレクトリも含む）走査します。
21        // 各要素は SplFileInfo オブジェクトとして提供されます。
22        $recursiveIterator = new RecursiveIteratorIterator($directoryIterator);
23
24        $foundFilesCount = 0;
25
26        // 各要素（ファイルまたはディレクトリ）を反復処理します。
27        foreach ($recursiveIterator as $fileInfo) {
28            // isFile() メソッドは、現在の要素が通常のファイルである場合に true を返します。
29            // ディレクトリ、シンボリックリンク、特殊ファイルは含まれません。
30            if ($fileInfo->isFile()) {
31                // ファイルが見つかった場合、そのフルパスを表示します。
32                echo "見つかったファイル: " . $fileInfo->getPathname() . "\n";
33                $foundFilesCount++;
34            }
35        }
36
37        if ($foundFilesCount === 0) {
38            echo "指定されたディレクトリ '{$path}' およびそのサブディレクトリ内にファイルは見つかりませんでした。\n";
39        } else {
40            echo "合計 {$foundFilesCount} 個のファイルが見つかりました。\n";
41        }
42
43    } catch (UnexpectedValueException $e) {
44        // 指定されたパスが存在しない、またはディレクトリではない場合に発生するエラーを処理します。
45        echo "エラー: 指定されたパス '{$path}' が無効か、ディレクトリではありません。\n";
46        echo "詳細: " . $e->getMessage() . "\n";
47    }
48}
49
50// スクリプトを実行するカレントディレクトリを対象にファイル検索を実行します。
51// ヒント: このスクリプトを実行する前に、カレントディレクトリにいくつかのファイルやサブディレクトリを作成してみてください。
52// 例:
53// mkdir my_test_dir
54// touch my_file.txt
55// touch my_test_dir/another_file.txt
56// mkdir my_test_dir/sub_dir
57// touch my_test_dir/sub_dir/file_in_subdir.log
58findFilesInDirectory('.');
59

PHPのRecursiveDirectoryIterator::isFile()メソッドは、ファイルシステム上の特定の要素が「通常のファイル」であるかどうかを判定するために使用されます。このメソッドは引数を受け取らず、判定結果を真偽値（bool）で返します。trueが返された場合、その要素はファイルであり、falseが返された場合はディレクトリやシンボリックリンク、その他の特殊な要素であることを示します。

サンプルコードでは、RecursiveDirectoryIteratorとRecursiveIteratorIteratorを組み合わせて、指定されたディレクトリとそのサブディレクトリを再帰的に走査しています。走査中に取得される各要素（$fileInfo）に対してisFile()メソッドが呼び出され、それがファイルである場合にのみそのパスが表示されます。これにより、ディレクトリ構造の中から目的のファイルを効率的に見つけ出すことができます。

この機能は、特定の種類のファイルを検索したり、ファイルだけを対象に処理を行ったりする場合に非常に役立ちます。例えば、設定ファイルやログファイルなど、特定の拡張子を持つファイルを一括で処理したい際に、ディレクトリとファイルを区別するためにこのisFile()メソッドが活用されます。エラーハンドリングも含まれており、指定パスが無効な場合の処理も考慮されています。