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

Copy
1<?php
2
3/**
4 * RecursiveDirectoryIterator::isDot() メソッドの使用例を示します。
5 *
6 * このメソッドは、現在のイテレータ項目が特殊なディレクトリ '. (現在のディレクトリ)' または
7 * '.. (親ディレクトリ)' であるかどうかを判定します。
8 *
9 * キーワード「php isdigit」に関連して、ドットエントリでない場合にファイル名が数字のみで
10 * 構成されているかを確認する例も含まれています。
11 */
12function demonstrateIsDotUsage(): void
13{
14    // 一時ディレクトリを作成し、テスト用のファイルとディレクトリを配置します。
15    // これにより、単体で動作し、様々なファイルタイプをテストできます。
16    $testDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'isdot_test_' . uniqid();
17    mkdir($testDir);
18    file_put_contents($testDir . DIRECTORY_SEPARATOR . 'file_alpha.txt', 'Content A');
19    file_put_contents($testDir . DIRECTORY_SEPARATOR . '123.log', 'Content B');
20    mkdir($testDir . DIRECTORY_SEPARATOR . 'numeric_dir_456');
21    file_put_contents($testDir . DIRECTORY_SEPARATOR . 'numeric_dir_456' . DIRECTORY_SEPARATOR . 'data.csv', 'Content C');
22    mkdir($testDir . DIRECTORY_SEPARATOR . 'sub_dir');
23    file_put_contents($testDir . DIRECTORY_SEPARATOR . 'sub_dir' . DIRECTORY_SEPARATOR . 'file_beta.txt', 'Content D');
24
25    echo "--- ディレクトリツリー走査開始: {$testDir} ---\n\n";
26
27    try {
28        // RecursiveDirectoryIterator を作成します。
29        // デフォルトでは '.' と '..' も走査対象に含まれます。
30        // RecursiveDirectoryIterator::CURRENT_AS_FILEINFO は、各エントリが SplFileInfo オブジェクトとして
31        // 扱われることを保証し、getFilename() や isDot() などのメソッドが使用できるようになります。
32        $directoryIterator = new RecursiveDirectoryIterator(
33            $testDir,
34            RecursiveDirectoryIterator::CURRENT_AS_FILEINFO
35        );
36
37        // RecursiveIteratorIterator を使用して、サブディレクトリも含めて再帰的に走査します。
38        $iterator = new RecursiveIteratorIterator($directoryIterator);
39
40        foreach ($iterator as $fileInfo) {
41            // isDot() メソッドを使用して、現在のエントリが '.' または '..' かどうかを判定します。
42            // これらの特殊なエントリは、ファイルやディレクトリのリストから除外されることがよくあります。
43            if ($fileInfo->isDot()) {
44                echo "[ドットエントリ]   '{$fileInfo->getFilename()}' (フルパス: {$fileInfo->getPathname()}) - isDot() が true を返しました。\n";
45            } else {
46                echo "[通常エントリ]   '{$fileInfo->getFilename()}' (フルパス: {$fileInfo->getPathname()}) - isDot() が false を返しました。\n";
47
48                // キーワード「isdigit」に関連して、ファイル名が数字のみで構成されているかを確認します。
49                // PHP の ctype_digit() 関数は、文字列がすべて数字である場合に true を返します。
50                $filename = $fileInfo->getFilename();
51                if (ctype_digit($filename)) {
52                    echo "  -> 注意: ファイル名 '{$filename}' は数字のみで構成されています。\n";
53                } else {
54                    echo "  -> 注意: ファイル名 '{$filename}' は数字のみではありません。\n";
55                }
56            }
57        }
58        echo "\n--- ディレクトリツリー走査終了 ---\n";
59
60    } catch (UnexpectedValueException $e) {
61        // 指定されたパスがディレクトリでない、またはアクセスできない場合に発生します。
62        echo "エラー: ディレクトリの走査中に問題が発生しました - " . $e->getMessage() . "\n";
63    } finally {
64        // テスト用のディレクトリとファイルをクリーンアップします。
65        // SKIP_DOTS を使用して '.' と '..' を無視し、安全に削除します。
66        $cleanupIterator = new RecursiveIteratorIterator(
67            new RecursiveDirectoryIterator($testDir, RecursiveDirectoryIterator::SKIP_DOTS),
68            RecursiveIteratorIterator::CHILD_FIRST
69        );
70        foreach ($cleanupIterator as $path) {
71            $path->isDir() && !$path->isLink() ? rmdir($path->getPathname()) : unlink($path->getPathname());
72        }
73        rmdir($testDir);
74        echo "一時ディレクトリ '{$testDir}' をクリーンアップしました。\n";
75    }
76}
77
78// 関数を実行します。
79demonstrateIsDotUsage();

RecursiveDirectoryIterator::isDot()は、PHPでファイルシステムを再帰的に走査する際に、現在のイテレータ項目が特殊なディレクトリである「.（現在のディレクトリ）」または「..（親ディレクトリ）」であるかを判別するためのメソッドです。このメソッドは引数を必要とせず、該当する場合はtrueを、それ以外の通常のファイルやディレクトリの場合はfalseを真偽値として返します。

このサンプルコードでは、一時的なテスト用ディレクトリとその中にファイルやサブディレクトリを作成し、RecursiveDirectoryIteratorとRecursiveIteratorIteratorを使ってディレクトリツリー全体を走査しています。各ファイルやディレクトリに対してisDot()メソッドを呼び出し、それが「.」や「..」といった特殊なエントリであるかを判定します。isDot()がtrueを返した場合、そのエントリは特殊なディレクトリであるため、多くのファイル処理ではスキップされることが一般的です。

一方、isDot()がfalseを返した通常のファイルやディレクトリに対しては、キーワード「php isdigit」に関連して、そのファイル名が数字のみで構成されているかをPHPのctype_digit()関数で確認しています。これは、特定の命名規則を持つファイルを識別する際に応用できる例です。このメソッドは、ファイル操作を行うスクリプトなどで、特殊なディレクトリを適切に処理し、意図しない動作を防ぐために非常に役立ちます。最後に、テスト用に作成したディレクトリとファイルはすべてクリーンアップされます。

Copy
1<?php
2
3/**
4 * 指定されたディレクトリとその内容を再帰的に削除します。
5 *
6 * @param string $dirPath 削除するディレクトリのパス
7 * @return bool 成功した場合はtrue、失敗した場合はfalse
8 */
9function cleanupDirectory(string $dirPath): bool
10{
11    if (!is_dir($dirPath)) {
12        return false;
13    }
14
15    // RecursiveIteratorIterator を使用して、サブディレクトリ内のファイルも処理します。
16    // SKIP_DOTS フラグで '.' と '..' エントリをスキップします。
17    // CHILD_FIRST モードで、子要素（ファイルやサブディレクトリの内容）を先に削除します。
18    $files = new RecursiveIteratorIterator(
19        new RecursiveDirectoryIterator($dirPath, RecursiveDirectoryIterator::SKIP_DOTS),
20        RecursiveIteratorIterator::CHILD_FIRST
21    );
22
23    foreach ($files as $fileinfo) {
24        // ディレクトリの場合は rmdir、ファイルの場合は unlink を使用します。
25        if ($fileinfo->isDir()) {
26            rmdir($fileinfo->getRealPath());
27        } else {
28            unlink($fileinfo->getRealPath());
29        }
30    }
31    // 最後に空になったルートディレクトリを削除します。
32    return rmdir($dirPath);
33}
34
35/**
36 * RecursiveDirectoryIterator::isDot() メソッドの動作をデモンストレーションします。
37 * このメソッドは、現在のエントリがディレクトリの特殊なエントリ（'.' または '..'）であるかをチェックします。
38 */
39function demonstrateIsDot(): void
40{
41    // 一時テストディレクトリをシステムの一時ディレクトリ内に作成します。
42    // uniqid() を使用して、ディレクトリ名が一意になるようにします。
43    $testDirPath = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_isdot_example_' . uniqid();
44
45    // ディレクトリの作成を試み、失敗した場合は処理を終了します。
46    if (!mkdir($testDirPath) && !is_dir($testDirPath)) {
47        echo "エラー: テストディレクトリの作成に失敗しました: {$testDirPath}\n";
48        return;
49    }
50
51    // テスト用のファイルとサブディレクトリを作成します。
52    // これらのエントリは '.' や '..' ではないため、isDot() は false を返します。
53    file_put_contents($testDirPath . DIRECTORY_SEPARATOR . 'file1.txt', 'Content for file1');
54    mkdir($testDirPath . DIRECTORY_SEPARATOR . 'subdir');
55    file_put_contents($testDirPath . DIRECTORY_SEPARATOR . 'subdir' . DIRECTORY_SEPARATOR . 'file2.txt', 'Content for file2');
56
57    echo "--- ディレクトリ走査開始: {$testDirPath} ---\n";
58
59    try {
60        // RecursiveDirectoryIterator をインスタンス化します。
61        // これにより、指定されたディレクトリ内の各エントリ（ファイル、ディレクトリ、'.'、'..'）を繰り返し処理できます。
62        $iterator = new RecursiveDirectoryIterator($testDirPath);
63
64        // ディレクトリのエントリをループ処理します。
65        // 各 $entry は SplFileInfo のインスタンスであり、isDot() メソッドを持ちます。
66        foreach ($iterator as $entry) {
67            // isDot() メソッドを使用して、エントリが特殊なディレクトリ（'.' または '..'）であるかを判断します。
68            if ($entry->isDot()) {
69                echo "[特殊] {$entry->getPathname()} (isDot: true)\n";
70            } else {
71                echo "[通常] {$entry->getPathname()} (isDot: false)\n";
72            }
73        }
74    } catch (Exception $e) {
75        // ディレクトリの読み取り中にエラーが発生した場合にキャッチします。
76        echo "エラーが発生しました: " . $e->getMessage() . "\n";
77    } finally {
78        echo "--- ディレクトリ走査終了 ---\n";
79        // 作成したテストディレクトリとその内容をクリーンアップします。
80        if (cleanupDirectory($testDirPath)) {
81            echo "テストディレクトリが正常にクリーンアップされました: {$testDirPath}\n";
82        } else {
83            echo "テストディレクトリのクリーンアップに失敗しました: {$testDirPath}\n";
84        }
85    }
86}
87
88// demonstrateIsDot() 関数を実行し、デモンストレーションを開始します。
89demonstrateIsDot();
90
91?>

PHPのRecursiveDirectoryIteratorクラスに属するisDot()メソッドは、ディレクトリを走査する際に、現在参照しているエントリが特殊なディレクトリである「.」（現在のディレクトリ）または「..」（親ディレクトリ）であるかを判定するために使用されます。このメソッドは引数を取らず、現在のエントリが「.」または「..」の場合にはtrueを、それ以外のファイルやサブディレクトリである場合にはfalseをブール値として返します。

サンプルコードでは、一時ディレクトリを作成し、その中のエントリをRecursiveDirectoryIteratorで一つずつ処理しています。foreachループ内で各エントリに対して$entry->isDot()を呼び出すことで、そのエントリが「.」や「..」なのか、それとも作成したファイルやサブディレクトリなのかを区別し、異なるメッセージを表示しています。これにより、ディレクトリの内容を処理する際に、システムが自動的に生成するこれらの特殊なエントリを識別し、処理の対象から除外するなどの制御を簡単に行うことが可能となります。