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

Copy
1<?php
2
3/**
4 * FilesystemIterator::isDot() メソッドの使用例を示します。
5 *
6 * この関数は、指定されたディレクトリを走査し、各エントリが '.' または '..' のような
7 * ドットエントリであるかどうかを判断します。
8 *
9 * @param string $directoryPath 走査するディレクトリのパス。
10 */
11function demonstrateFilesystemIteratorIsDot(string $directoryPath): void
12{
13    echo "ディレクトリ '{$directoryPath}' を走査しています...\n";
14    echo "--------------------------------------------------\n";
15
16    try {
17        // FilesystemIterator を作成します。
18        // デフォルトでは '.' と '..' も含まれますが、
19        // FilesystemIterator::SKIP_DOTS フラグを使うとスキップされます。
20        // isDot() の動作を確認するため、ここではフラグを使用しません。
21        $iterator = new FilesystemIterator($directoryPath);
22
23        foreach ($iterator as $fileInfo) {
24            $name = $fileInfo->getFilename(); // 現在のエントリの名前を取得
25
26            // isDot() メソッドを呼び出して、現在のエントリがドットエントリかどうかを判断します。
27            $isDot = $fileInfo->isDot(); 
28
29            if ($isDot) {
30                echo "  [ドットエントリ] '{$name}' はドットエントリです。\n";
31            } else {
32                echo "  [通常エントリ] '{$name}' は通常のファイル/ディレクトリです。\n";
33            }
34        }
35    } catch (UnexpectedValueException $e) {
36        // ディレクトリが存在しない、またはアクセスできない場合のエラーを捕捉します。
37        echo "エラー: ディレクトリ '{$directoryPath}' にアクセスできませんでした。\n";
38        echo "詳細: " . $e->getMessage() . "\n";
39    }
40
41    echo "--------------------------------------------------\n";
42}
43
44// --- サンプルコードの実行部分 ---
45
46// デモンストレーション用に一時ディレクトリとファイルを作成します。
47$tempDir = __DIR__ . '/is_dot_demo_temp_dir';
48if (!file_exists($tempDir)) {
49    mkdir($tempDir);
50}
51file_put_contents($tempDir . '/example_file.txt', 'This is a test file.');
52mkdir($tempDir . '/example_subdir');
53file_put_contents($tempDir . '/example_subdir/another_file.txt', 'Another test file.');
54
55// demonstrateFilesystemIteratorIsDot 関数を実行します。
56demonstrateFilesystemIteratorIsDot($tempDir);
57
58// 後処理: 作成した一時ディレクトリとファイルを削除します。
59function removeTempDir(string $dir): void
60{
61    $files = array_diff(scandir($dir), ['.', '..']);
62    foreach ($files as $file) {
63        (is_dir("$dir/$file")) ? removeTempDir("$dir/$file") : unlink("$dir/$file");
64    }
65    rmdir($dir);
66}
67removeTempDir($tempDir);
68
69// 存在しないディレクトリを試して、エラー処理を確認する例
70echo "\n--- 存在しないディレクトリの例 ---\n";
71demonstrateFilesystemIteratorIsDot(__DIR__ . '/non_existent_directory_123');
72
73?>

PHP 8のFilesystemIteratorクラスに属するisDot()メソッドは、ファイルシステムを走査する際に、現在処理しているエントリが特殊なドットエントリである「.」（カレントディレクトリ）または「..」（親ディレクトリ）であるかを判定するために使用されます。このメソッドは引数を必要とせず、現在のエントリがドットエントリであれば真偽値trueを、そうでなければfalseを返します。

サンプルコードでは、まず指定されたディレクトリのパスを用いてFilesystemIteratorのインスタンスを作成し、そのディレクトリ内の各ファイルやサブディレクトリを順番に処理します。それぞれの項目についてisDot()メソッドを呼び出すことで、それがドットエントリであるかを判別しています。この判別結果に基づいて、「ドットエントリです」あるいは「通常のファイル/ディレクトリです」といったメッセージを出力し、各エントリの種類を明確に示しています。これにより、プログラムがディレクトリの内容を詳細に分析し、特殊なエントリを区別して適切に処理する際の基準として活用できます。

Copy
1<?php
2
3/**
4 * FilesystemIterator::isDot() メソッドの使用例を示します。
5 *
6 * この関数は一時ディレクトリを作成し、その内容を FilesystemIterator で走査し、
7 * 各エントリがドットエントリ (. または ..) であるかどうかを isDot() メソッドで判定します。
8 * システムエンジニアを目指す初心者にも分かりやすいように、詳細なコメントを含みます。
9 *
10 * PHPの推奨コーディングスタイルに従い、単体で動作可能です。
11 */
12function demonstrateFilesystemIteratorIsDot(): void
13{
14    // 1. テスト用の一時ディレクトリとファイルをセットアップ
15    // システムの一時ディレクトリを使用し、一意の名前を生成
16    $tempDir = sys_get_temp_dir() . '/sample_dir_' . uniqid();
17
18    // ディレクトリを作成
19    if (!mkdir($tempDir, 0777, true)) {
20        echo "エラー: ディレクトリ '{$tempDir}' の作成に失敗しました。" . PHP_EOL;
21        return;
22    }
23
24    // サンプルファイルとサブディレクトリを作成
25    file_put_contents($tempDir . '/file1.txt', 'This is file1.');
26    mkdir($tempDir . '/subdir1');
27    file_put_contents($tempDir . '/subdir1/file2.txt', 'This is file2 in subdir1.');
28    file_put_contents($tempDir . '/.hidden_file.txt', 'This is a hidden file.'); // ドットファイル（Unix系OSで隠しファイル）
29
30    echo "一時ディレクトリを作成しました: " . $tempDir . PHP_EOL;
31    echo "テスト用の内容:" . PHP_EOL;
32    echo "- {$tempDir}/file1.txt" . PHP_EOL;
33    echo "- {$tempDir}/subdir1/" . PHP_EOL;
34    echo "- {$tempDir}/.hidden_file.txt" . PHP_EOL . PHP_EOL;
35
36    try {
37        // 2. FilesystemIterator を使用してディレクトリを走査
38        //    FilesystemIterator::SKIP_DOTS を指定しない場合、'.' (カレントディレクトリ) と '..' (親ディレクトリ)
39        //    という特別なドットエントリも走査対象に含まれます。
40        //
41        //    KEY_AS_PATHNAME: イテレータのキーをファイルのフルパスに設定します。
42        //    CURRENT_AS_FILEINFO: イテレータの値を SplFileInfo オブジェクトに設定します。
43        //                         これにより、isDot() などのメソッドが使用可能になります。
44        $iterator = new FilesystemIterator(
45            $tempDir,
46            FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO
47        );
48
49        echo "FilesystemIterator でディレクトリを走査しています (ドットエントリ含む):" . PHP_EOL;
50        foreach ($iterator as $fileInfo) {
51            $path = $fileInfo->getPathname();
52            echo "  - " . $path;
53
54            // FilesystemIterator::isDot() メソッド:
55            // 現在のイテレータが参照しているエントリが '.' または '..' である場合に true を返します。
56            $isDotEntry = $fileInfo->isDot();
57
58            if ($isDotEntry) {
59                echo " (ドットエントリ: . または ..)";
60            } elseif ($fileInfo->isDir()) {
61                echo " (ディレクトリ)";
62            } elseif ($fileInfo->isFile()) {
63                echo " (ファイル)";
64            }
65            echo PHP_EOL;
66        }
67        echo PHP_EOL;
68
69        // 3. FilesystemIterator::SKIP_DOTS を指定した場合の例
70        //    このフラグを指定すると、'.' と '..' は走査対象から除外されます。
71        echo "FilesystemIterator::SKIP_DOTS を指定して再度走査 (ドットエントリ除外):" . PHP_EOL;
72        $iteratorSkipDots = new FilesystemIterator(
73            $tempDir,
74            FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::SKIP_DOTS
75        );
76        foreach ($iteratorSkipDots as $fileInfo) {
77            $path = $fileInfo->getPathname();
78            echo "  - " . $path;
79            // この場合、isDot() は常に false を返します（または呼ばれる必要がありません）。
80            if ($fileInfo->isDir()) {
81                echo " (ディレクトリ)";
82            } elseif ($fileInfo->isFile()) {
83                echo " (ファイル)";
84            }
85            echo PHP_EOL;
86        }
87
88    } catch (UnexpectedValueException $e) {
89        // 指定されたパスがディレクトリでない場合や、アクセス権限がない場合などに発生
90        echo "エラー: ディレクトリの走査中に問題が発生しました - " . $e->getMessage() . PHP_EOL;
91    } finally {
92        // 4. 使用した一時ディレクトリとファイルをクリーンアップ
93        // RecursiveDirectoryIterator を使ってサブディレクトリ内のファイルも削除します。
94        if (is_dir($tempDir)) {
95            $files = new RecursiveIteratorIterator(
96                new RecursiveDirectoryIterator($tempDir, RecursiveDirectoryIterator::SKIP_DOTS),
97                RecursiveIteratorIterator::CHILD_FIRST
98            );
99
100            foreach ($files as $fileinfo) {
101                if ($fileinfo->isDir()) {
102                    // ディレクトリを削除
103                    rmdir($fileinfo->getRealPath());
104                } else {
105                    // ファイルを削除
106                    unlink($fileinfo->getRealPath());
107                }
108            }
109            // 最後にルートディレクトリを削除
110            rmdir($tempDir);
111            echo PHP_EOL . "一時ディレクトリ '{$tempDir}' をクリーンアップしました。" . PHP_EOL;
112        }
113    }
114}
115
116// 関数を実行して FilesystemIterator::isDot() の動作を確認します。
117demonstrateFilesystemIteratorIsDot();
118

PHP 8のFilesystemIteratorクラスに属するisDot()メソッドは、ディレクトリ内のエントリが特殊な「ドットエントリ」であるかどうかを判定するために使用します。このメソッドは引数を受け取らず、真偽値（bool）を返します。

「ドットエントリ」とは、ファイルシステムにおいて、現在のディレクトリを指す「.（ドット）」と、親ディレクトリを指す「..（ドットドット）」を意味する特別なエントリのことです。isDot()メソッドは、FilesystemIteratorが現在処理しているファイルやディレクトリがこれらのドットエントリである場合にtrueを返し、通常のファイルやディレクトリであればfalseを返します。

このメソッドは、ディレクトリを走査する際に、.や..といった特別なエントリと、それ以外の実際のファイルやサブディレクトリを区別したい場合に非常に便利です。たとえば、ディレクトリの内容を一覧表示する際に、これらのドットエントリを除外して表示したいといった場面で活用できます。なお、FilesystemIteratorのコンストラクタにFilesystemIterator::SKIP_DOTSフラグを指定することで、そもそもドットエントリを走査対象から除外することも可能です。