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

Copy
1<?php
2
3// FilesystemIterator::isFile() メソッドの使用例
4// このスクリプトは一時的なディレクトリとファイルを作成し、FilesystemIterator を使って走査し、
5// 各エントリがファイルであるかどうかを isFile() メソッドで判定します。
6
7/**
8 * 一時的なテスト環境（ディレクトリとファイル）を作成します。
9 *
10 * @param string $dirPath 作成するディレクトリのパス
11 */
12function setupTestEnvironment(string $dirPath): void
13{
14    // ディレクトリが存在しない場合、再帰的に作成
15    if (!file_exists($dirPath)) {
16        mkdir($dirPath, 0777, true);
17        echo "ディレクトリを作成しました: {$dirPath}\n";
18    }
19
20    // テスト用のファイルをいくつか作成
21    file_put_contents($dirPath . '/test_file_a.txt', 'Content for file A.');
22    file_put_contents($dirPath . '/test_file_b.log', 'Content for file B.');
23    echo "ファイル 'test_file_a.txt' と 'test_file_b.log' を作成しました。\n";
24
25    // テスト用のサブディレクトリを作成
26    mkdir($dirPath . '/test_subdir', 0777, true);
27    file_put_contents($dirPath . '/test_subdir/nested_file.md', 'Content for nested file.');
28    echo "サブディレクトリ 'test_subdir' とその中の 'nested_file.md' を作成しました。\n";
29}
30
31/**
32 * 作成したテスト環境（ディレクトリとファイル）をクリーンアップ（削除）します。
33 *
34 * @param string $dirPath 削除するディレクトリのパス
35 */
36function cleanupTestEnvironment(string $dirPath): void
37{
38    // ディレクトリが存在しない場合は何もしない
39    if (!is_dir($dirPath)) {
40        return;
41    }
42
43    // ディレクトリ内のすべての要素を走査
44    // FilesystemIterator::SKIP_DOTS フラグは "." と ".." をスキップします
45    $iterator = new FilesystemIterator($dirPath, FilesystemIterator::SKIP_DOTS);
46    foreach ($iterator as $item) {
47        if ($item->isDir()) {
48            // 要素がディレクトリの場合、再帰的に削除関数を呼び出す
49            cleanupTestEnvironment($item->getPathname());
50        } else {
51            // 要素がファイルの場合、ファイルを削除
52            unlink($item->getPathname());
53        }
54    }
55    // ディレクトリが空になったら、そのディレクトリ自体を削除
56    rmdir($dirPath);
57    echo "ディレクトリをクリーンアップしました: {$dirPath}\n";
58}
59
60// 一時的なテストディレクトリのパスを定義
61$tempDir = __DIR__ . '/php_iterator_test_dir';
62
63// 1. テスト環境をセットアップ
64echo "=== テスト環境のセットアップ ===\n";
65setupTestEnvironment($tempDir);
66echo "\n";
67
68// 2. FilesystemIterator を使用してディレクトリを走査し、isFile() を呼び出す
69echo "=== FilesystemIterator::isFile() の実行結果 ===\n";
70try {
71    // FilesystemIterator をインスタンス化
72    // FilesystemIterator::SKIP_DOTS は、"." と ".." を結果から除外します。
73    $iterator = new FilesystemIterator($tempDir, FilesystemIterator::SKIP_DOTS);
74
75    // イテレータをループして、各エントリについて処理
76    foreach ($iterator as $fileInfo) {
77        echo "パス: " . $fileInfo->getPathname() . "\n";
78        echo "  ファイル名: " . $fileInfo->getFilename() . "\n";
79
80        // isFile() メソッドを使って、現在の要素がファイルであるかチェック
81        if ($fileInfo->isFile()) {
82            echo "  結果: これはファイルです。\n";
83        } else {
84            echo "  結果: これはファイルではありません（ディレクトリなど）。\n";
85        }
86        echo "--------------------------\n";
87    }
88} catch (UnexpectedValueException $e) {
89    echo "エラー: 指定されたディレクトリ '{$tempDir}' を開けませんでした。\n";
90    echo "メッセージ: " . $e->getMessage() . "\n";
91} finally {
92    // 3. テスト環境をクリーンアップ
93    echo "\n=== テスト環境のクリーンアップ ===\n";
94    cleanupTestEnvironment($tempDir);
95}
96
97?>

PHP 8 の FilesystemIterator::isFile() メソッドは、ファイルシステムを効率的に走査する際に、現在イテレータが指している要素が「通常のファイル」であるかどうかを判定するために使用されるものです。このメソッドは FilesystemIterator クラスのインスタンスから呼び出され、ディレクトリ内の各エントリの種類を調べます。

isFile() は引数を一切取らず、現在の要素が通常のファイルであれば true を、ディレクトリやシンボリックリンクなどのファイル以外の要素であれば false を真偽値（bool）として返します。

サンプルコードでは、まず一時的なテストディレクトリと複数のファイル、そしてサブディレクトリを作成してテスト環境を準備しています。その後、FilesystemIterator を用いてこのディレクトリの内容を一つずつ走査し、ループ内で各エントリに対して isFile() メソッドを呼び出しています。これにより、そのエントリがファイルであるか、それ以外の要素であるかを判別し、結果を表示しています。このメソッドは、ディレクトリ内の要素を種類に応じて適切に処理する際の判断基準として非常に役立ちます。処理の完了後には、作成したテスト環境がクリーンアップされます。

Copy
1<?php
2
3/**
4 * FilesystemIterator::isFile メソッドの使用方法をデモンストレーションします。
5 *
6 * この関数は一時ディレクトリを作成し、ファイルとサブディレクトリを配置し、
7 * FilesystemIterator を使ってその中身を走査し、各エントリがファイルであるかを
8 * isFile() メソッドで判定する例を示します。
9 * 最後に、作成した一時ディレクトリをクリーンアップします。
10 *
11 * @return void
12 */
13function demonstrateFilesystemIteratorIsFileUsage(): void
14{
15    // 1. テスト用の一時ディレクトリを設定します。
16    // uniqid() を使用して一意なディレクトリ名を作成し、他のファイルとの衝突を防ぎます。
17    $testDir = __DIR__ . '/temp_filesystem_iterator_test_' . uniqid();
18    echo "テストディレクトリを作成中: {$testDir}" . PHP_EOL;
19
20    try {
21        // 2. テスト用ディレクトリとファイルを作成します。
22        // mkdir() でディレクトリを作成し、file_put_contents() でファイルを作成します。
23        if (!mkdir($testDir, 0777, true)) {
24            throw new RuntimeException("テストディレクトリ '{$testDir}' の作成に失敗しました。");
25        }
26        file_put_contents($testDir . '/document.txt', 'This is a text file.');
27        file_put_contents($testDir . '/image.jpg', 'fake image data'); // これは通常のファイルとして扱われます。
28        if (!mkdir($testDir . '/subdir', 0777)) {
29            throw new RuntimeException("サブディレクトリ '{$testDir}/subdir' の作成に失敗しました。");
30        }
31        file_put_contents($testDir . '/subdir/report.pdf', 'fake pdf data'); // サブディレクトリ内のファイル
32
33        echo "テストファイルとサブディレクトリを配置しました。" . PHP_EOL;
34
35        // 3. FilesystemIterator を使用してディレクトリを走査し、isFile() を呼び出します。
36        echo PHP_EOL . "--- ディレクトリ '{$testDir}' の内容を走査中 ---" . PHP_EOL;
37
38        // FilesystemIterator::SKIP_DOTS フラグは、'.' (現在のディレクトリ) と '..' (親ディレクトリ) のエントリをスキップします。
39        // FilesystemIterator オブジェクトは SplFileInfo を継承しているため、isFile() などのメソッドを直接呼び出すことができます。
40        $iterator = new FilesystemIterator($testDir, FilesystemIterator::SKIP_DOTS);
41
42        foreach ($iterator as $fileInfo) {
43            $entryName = $fileInfo->getFilename(); // 現在のエントリの名前を取得します。
44
45            // isFile() メソッドで、エントリが通常のファイルであるかをチェックします。
46            // ディレクトリ、シンボリックリンク、特殊ファイルは 'false' を返します。
47            if ($fileInfo->isFile()) {
48                echo "  '{$entryName}' は通常のファイルです。" . PHP_EOL;
49            } else {
50                echo "  '{$entryName}' は通常のファイルではありません (例: ディレクトリ)。" . PHP_EOL;
51            }
52        }
53        echo "--- 走査完了 ---" . PHP_EOL;
54
55    } catch (RuntimeException $e) {
56        // ディレクトリやファイルの作成に失敗した場合の例外を捕捉します。
57        echo "エラー: " . $e->getMessage() . PHP_EOL;
58    } catch (UnexpectedValueException $e) {
59        // FilesystemIterator のコンストラクタが失敗した場合 (例: 指定されたパスが存在しない、権限がない) の例外を捕捉します。
60        echo "エラー: ディレクトリ '{$testDir}' の走査に失敗しました。 " . $e->getMessage() . PHP_EOL;
61    } finally {
62        // 4. クリーンアップ: 作成した一時ディレクトリとファイルを削除します。
63        // finally ブロックは、try/catch ブロックの実行結果に関わらず必ず実行されます。
64        echo PHP_EOL . "テストディレクトリをクリーンアップ中: {$testDir}" . PHP_EOL;
65        if (file_exists($testDir)) {
66            // ディレクトリとその中身を再帰的に削除するためのイテレータを使用します。
67            $files = new RecursiveIteratorIterator(
68                new RecursiveDirectoryIterator($testDir, FilesystemIterator::SKIP_DOTS),
69                RecursiveIteratorIterator::CHILD_FIRST // 子要素から先に処理 (ファイルの削除後、ディレクトリの削除)
70            );
71
72            foreach ($files as $file) {
73                if ($file->isDir()) {
74                    rmdir($file->getRealPath()); // ディレクトリを削除
75                } else {
76                    unlink($file->getRealPath()); // ファイルを削除
77                }
78            }
79            rmdir($testDir); // 空になったルートテストディレクトリを削除
80            echo "テストディレクトリを削除しました。" . PHP_EOL;
81        } else {
82            echo "テストディレクトリは既に存在しませんでした。" . PHP_EOL;
83        }
84    }
85}
86
87// 関数を実行してデモンストレーションを開始します。
88demonstrateFilesystemIteratorIsFileUsage();

FilesystemIterator::isFile() メソッドは、PHPでファイルシステムを操作する際に、現在走査している項目が「通常のファイル」であるかを判定するために使用されます。このメソッドは FilesystemIterator クラスに属しており、ディレクトリ内の各エントリを順に処理しながら、その種類を判別する際に役立ちます。

このメソッドは引数を必要とせず、呼び出すだけで現在のエントリがファイルであるかをチェックします。戻り値は真偽値（bool）で、もしイテレータが参照しているエントリがテキストファイルや画像ファイルのような一般的なファイルであれば true を返します。一方、エントリがサブディレクトリであったり、シンボリックリンクや特殊なファイルタイプである場合は false を返します。

これにより、特定のディレクトリの中からファイルのみを抽出して処理したい場合や、ファイルとディレクトリで異なる処理を行いたい場合などに非常に効果的です。例えば、特定の拡張子を持つファイルだけを対象に処理を実行したり、ファイルシステムに存在する項目の中からディレクトリを除外し、ファイルだけを一覧表示したりするような場面で、正確かつ効率的なプログラムの記述を可能にします。