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

Copy
1<?php
2
3/**
4 * GlobIterator::isFile() メソッドの使用例
5 *
6 * このスクリプトは、指定されたパターンに一致するファイルシステムエントリを反復処理し、
7 * 各要素がファイルであるかどうかを GlobIterator から取得した SplFileInfo オブジェクトの
8 * isFile() メソッドで判定します。
9 *
10 * 実行前にテスト用のファイルとディレクトリを作成し、スクリプトの実行後に削除します。
11 * これにより、コードが単体で動作し、環境を汚染しないようにしています。
12 */
13
14// 一時ディレクトリのパスを定義
15$tempDir = __DIR__ . DIRECTORY_SEPARATOR . 'temp_for_glob_test';
16
17// テスト用のファイルとディレクトリをセットアップする関数
18function setupTestFiles(string $basePath): void
19{
20    // ベースディレクトリが存在しない場合は作成
21    if (!is_dir($basePath)) {
22        mkdir($basePath, 0777, true);
23    }
24
25    // テスト用のサブディレクトリを作成
26    $subDir = $basePath . DIRECTORY_SEPARATOR . 'subdir_a';
27    if (!is_dir($subDir)) {
28        mkdir($subDir, 0777, true);
29    }
30
31    // テスト用のファイルを作成
32    file_put_contents($basePath . DIRECTORY_SEPARATOR . 'file1.txt', 'これはファイル1です。');
33    file_put_contents($subDir . DIRECTORY_SEPARATOR . 'file2.log', 'これはファイル2です。');
34    file_put_contents($basePath . DIRECTORY_SEPARATOR . 'another_file.dat', 'これは別のファイルです。');
35
36    echo "--- テストファイルとディレクトリをセットアップしました ---" . PHP_EOL;
37    echo "作成パス: " . realpath($basePath) . PHP_EOL . PHP_EOL;
38}
39
40// テスト用のファイルとディレクトリをクリーンアップする関数
41function cleanupTestFiles(string $basePath): void
42{
43    if (!is_dir($basePath)) {
44        return; // ディレクトリが存在しない場合は何もしない
45    }
46
47    // ディレクトリとその内容を再帰的に削除
48    // FilesystemIterator::SKIP_DOTS は '.' と '..' をスキップ
49    $files = new RecursiveIteratorIterator(
50        new RecursiveDirectoryIterator($basePath, FilesystemIterator::SKIP_DOTS),
51        RecursiveIteratorIterator::CHILD_FIRST
52    );
53
54    foreach ($files as $fileinfo) {
55        if ($fileinfo->isDir()) {
56            rmdir($fileinfo->getRealPath()); // ディレクトリを削除
57        } else {
58            unlink($fileinfo->getRealPath()); // ファイルを削除
59        }
60    }
61    rmdir($basePath); // 空になったベースディレクトリを削除
62
63    echo PHP_EOL . "--- テストファイルとディレクトリをクリーンアップしました ---" . PHP_EOL;
64}
65
66// プログラム実行
67try {
68    // 1. テスト用のファイルとディレクトリをセットアップ
69    setupTestFiles($tempDir);
70
71    echo "--- GlobIterator::isFile() の使用例 ---" . PHP_EOL;
72    echo "パターン: " . realpath($tempDir) . DIRECTORY_SEPARATOR . '*' . PHP_EOL . PHP_EOL;
73
74    // 2. GlobIterator をインスタンス化
75    // GLOB_BRACE は "{a,b}" のようなパターンも処理できるようにするが、ここでは不要。
76    // FilesystemIterator::KEY_AS_PATHNAME はキーに完全なパスを使用。
77    // FilesystemIterator::CURRENT_AS_FILEINFO はイテレータの現在値として SplFileInfo オブジェクトを返す。
78    $iterator = new GlobIterator(
79        $tempDir . DIRECTORY_SEPARATOR . '*',
80        FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO
81    );
82
83    if (!$iterator->valid()) {
84        echo "指定されたパターンに一致するファイルやディレクトリは見つかりませんでした。" . PHP_EOL;
85    }
86
87    // 3. イテレータを反復処理し、各要素がファイルであるか判定
88    foreach ($iterator as $fullPath => $fileInfo) {
89        // SplFileInfo オブジェクトの isFile() メソッドを使用して判定
90        if ($fileInfo->isFile()) {
91            echo "[ファイル] " . $fileInfo->getFilename() . " (パス: " . $fullPath . ")" . PHP_EOL;
92        } elseif ($fileInfo->isDir()) {
93            // isFile() が false の場合、ディレクトリである可能性もチェック
94            echo "[ディレクトリ] " . $fileInfo->getFilename() . " (パス: " . $fullPath . ")" . PHP_EOL;
95        } else {
96            // その他のタイプ（シンボリックリンクなど）
97            echo "[その他] " . $fileInfo->getFilename() . " (パス: " . $fullPath . ")" . PHP_EOL;
98        }
99    }
100} catch (UnexpectedValueException $e) {
101    // GlobIterator のコンストラクタが失敗した場合などに発生
102    echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
103} finally {
104    // 4. 後処理としてテストファイルをクリーンアップ
105    cleanupTestFiles($tempDir);
106}
107
108?>

このサンプルコードは、PHPのGlobIteratorクラスと、そこから得られるSplFileInfoオブジェクトのisFile()メソッドの利用方法を示しています。GlobIteratorは、シェルで使うglob関数（例: *.txt）のように、指定されたパターンに合致するファイルやディレクトリのパスを効率的に検索し、反復処理するためのクラスです。

コードではまず、一時的にテスト用のファイルとディレクトリを作成します。次に、GlobIteratorを使い、作成した一時ディレクトリ内のすべてのエントリ（ファイルとサブディレクトリ）を取得します。この際、FilesystemIterator::CURRENT_AS_FILEINFOフラグによって、各エントリがSplFileInfoというオブジェクトとして取得されます。

ループ処理の中で、SplFileInfoオブジェクトのisFile()メソッドが呼び出されます。このisFile()メソッドは引数を必要とせず、そのオブジェクトが通常のファイルを表している場合にtrueを、ディレクトリやシンボリックリンクなどのファイル以外の種類である場合にfalseを返します。この戻り値（真偽値）を基に、現在処理しているエントリがファイルなのか、それともディレクトリなのかを判別し、適切なメッセージを表示しています。

このメソッドを使うことで、ファイルシステムを探索する際に、ファイルとディレクトリを簡単に区別でき、目的に応じた処理を柔軟に実装できるようになります。最後に、作成したテスト環境は適切に削除され、実行環境をきれいに保ちます。

Copy
1<?php
2
3/**
4 * GlobIterator::isFile メソッドの使用例。
5 * このスクリプトは、一時的なディレクトリとファイルを作成し、
6 * GlobIterator を使ってそれらを走査し、isFile() でファイルかどうかを判定します。
7 */
8
9// 1. テスト用のディレクトリとファイルを作成します。
10// スクリプトが実行されるディレクトリに一時的なディレクトリを作成します。
11$testDir = __DIR__ . '/_php_glob_test_dir';
12if (!is_dir($testDir)) {
13    mkdir($testDir);
14    echo "テストディレクトリ '{$testDir}' を作成しました。\n";
15}
16
17// テスト用のファイルをいくつか作成します。
18file_put_contents($testDir . '/document.txt', 'これはテキストファイルです。');
19file_put_contents($testDir . '/report.log', 'これはログファイルです。');
20
21// テスト用のサブディレクトリを作成します。
22if (!is_dir($testDir . '/subfolder')) {
23    mkdir($testDir . '/subfolder');
24}
25file_put_contents($testDir . '/subfolder/nested_file.md', 'これはネストされたMarkdownファイルです。');
26
27echo "テストファイルとディレクトリを作成しました:\n";
28echo " - {$testDir}/document.txt\n";
29echo " - {$testDir}/report.log\n";
30echo " - {$testDir}/subfolder/\n";
31echo " - {$testDir}/subfolder/nested_file.md\n\n";
32
33// 2. GlobIterator を使用して、指定されたパターンに一致する項目を反復処理します。
34// ここでは、作成したテストディレクトリ直下のすべての項目 ('*') を対象とします。
35try {
36    // GlobIterator のインスタンスを作成します。
37    // 第1引数には、Globパターン（ファイル名パターン）を指定します。
38    // 例えば、`*.txt` とすれば `.txt` 拡張子のファイルのみを対象にできます。
39    $iterator = new GlobIterator($testDir . '/*');
40
41    echo "GlobIterator を使用して '{$testDir}/' 内を走査します:\n";
42
43    // イテレータをループして各項目を処理します。
44    // 各 $fileInfo オブジェクトは SplFileInfo のインスタンスであり、
45    // GlobIterator は SplFileInfo を継承しているので、isFile() メソッドが利用できます。
46    foreach ($iterator as $fileInfo) {
47        // getFilename() でファイルまたはディレクトリ名を取得します。
48        echo "  - " . $fileInfo->getFilename();
49
50        // isFile() メソッドを使用して、現在の項目が通常のファイルであるかを確認します。
51        // ディレクトリ、シンボリックリンク、FIFO、ソケットなどの場合は false を返します。
52        if ($fileInfo->isFile()) {
53            echo " は通常のファイルです。\n";
54        } else {
55            echo " はファイルではありません (ディレクトリ、シンボリックリンクなど)。\n";
56        }
57    }
58} catch (RuntimeException $e) {
59    // GlobIterator の初期化やイテレーション中にエラーが発生した場合に捕捉します。
60    echo "エラーが発生しました: " . $e->getMessage() . "\n";
61    echo "ヒント: 指定されたパスにアクセス権があるか、またはパターンに一致する項目が存在するか確認してください。\n";
62} finally {
63    // 3. テスト用のディレクトリとファイルをクリーンアップ（削除）します。
64    echo "\nテスト環境をクリーンアップしています...\n";
65    if (is_dir($testDir)) {
66        // RecursiveDirectoryIterator と RecursiveIteratorIterator を使用して、
67        // サブディレクトリ内のファイルも含め、すべてを削除します。
68        $files = new RecursiveIteratorIterator(
69            new RecursiveDirectoryIterator($testDir, RecursiveDirectoryIterator::SKIP_DOTS),
70            RecursiveIteratorIterator::CHILD_FIRST
71        );
72
73        foreach ($files as $fileinfo) {
74            $todo = ($fileinfo->isDir() ? 'rmdir' : 'unlink');
75            $todo($fileinfo->getRealPath());
76        }
77        rmdir($testDir);
78        echo "テストディレクトリ '{$testDir}' を削除しました。\n";
79    }
80}

PHP 8のGlobIterator::isFile()メソッドは、ファイルシステムを走査するGlobIteratorクラスが取得した項目が、通常のファイルであるかどうかを判定するために使用されます。このメソッドは引数を必要とせず、真偽値（bool）を返します。具体的には、対象の項目が通常のファイル（例えばテキストファイルや画像ファイルなど）であればtrueを、ディレクトリやシンボリックリンク、あるいは特殊なファイルである場合はfalseを返します。

GlobIteratorは、指定されたパターンに合致するファイルやディレクトリを探索し、その結果をSplFileInfoオブジェクトとして提供します。isFile()メソッドは、このSplFileInfoオブジェクトに対して呼び出され、探索された項目がデータを持つ「ファイル」なのか、それとも「ファイルではない」種類（例えばフォルダー）なのかを判別するのに役立ちます。

サンプルコードでは、一時的に作成されたファイルとディレクトリをGlobIteratorで走査し、取得された各項目に対してisFile()メソッドを適用しています。これにより、document.txtのような実際のファイルは「通常のファイル」と判断され、subfolderのようなディレクトリは「ファイルではない」と識別される様子を確認できます。この機能は、ファイルの一覧の中からディレクトリを除外したり、特定の種類の項目だけを処理したりする際に非常に有用です。