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

Copy
1<?php
2
3/**
4 * GlobIterator::isDot() の使用例を示します。
5 * このメソッドは、現在のイテレータ要素が '.' (カレントディレクトリ) または '..' (親ディレクトリ) である場合に true を返します。
6 * 通常、ファイルシステムを走査する際に、これらの特殊なディレクトリをスキップするために使用されます。
7 */
8function demonstrateGlobIteratorIsDot(): void
9{
10    // 一時ディレクトリのパスを生成します。
11    $testDirPath = sys_get_temp_dir() . '/php_glob_test_' . uniqid();
12
13    // テスト用のディレクトリとファイルを作成します。
14    // この一時ディレクトリはスクリプト実行後に自動的に削除されます。
15    if (!is_dir($testDirPath)) {
16        mkdir($testDirPath, 0777, true);
17    }
18    file_put_contents($testDirPath . '/file1.txt', 'Content for file1.');
19    mkdir($testDirPath . '/another_dir', 0777);
20    file_put_contents($testDirPath . '/another_dir/nested_file.txt', 'Content for nested file.');
21    file_put_contents($testDirPath . '/123.data', 'A file with a numeric-like name.'); // 数字を含むファイル名の例
22
23    echo "=== GlobIterator::isDot() のデモンストレーション ===\n";
24    echo "対象ディレクトリ: " . $testDirPath . "\n";
25    echo "---------------------------------------------------\n";
26
27    try {
28        // GlobIterator を使用して指定されたパス内のファイルとディレクトリを走査します。
29        // パターン '*' は、指定されたディレクトリ直下の全ての要素を意味します。
30        // FilesystemIterator::KEY_AS_PATHNAME: イテレータのキーを要素のフルパス名とします。
31        // FilesystemIterator::CURRENT_AS_FILEINFO: 現在の要素を SplFileInfo オブジェクトとして返します。
32        $iterator = new GlobIterator(
33            $testDirPath . '/*',
34            FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO
35        );
36
37        echo "ファイルシステム要素のリスト:\n";
38        foreach ($iterator as $path => $fileInfo) {
39            // isDot() メソッドを使用して、現在の要素が '.' または '..' (特殊なドットディレクトリ)
40            // かどうかをチェックします。これらは通常、ファイルシステム走査の際に処理から除外されます。
41            if ($fileInfo->isDot()) {
42                echo "  [スキップ] " . $path . " (特殊なドットディレクトリ)\n";
43                continue; // ドットファイルの場合は次の要素へ進みます
44            }
45
46            // ドットファイルでない要素の情報を表示します。
47            $type = $fileInfo->isDir() ? "ディレクトリ" : "ファイル";
48            echo "  [処理対象] " . $path . " (" . $type . ", 名前: " . $fileInfo->getFilename() . ")\n";
49        }
50    } catch (UnexpectedValueException $e) {
51        // GlobIterator のコンストラクタが失敗した場合の例外処理です。
52        echo "エラー: " . $e->getMessage() . "\n";
53    } finally {
54        // 後処理: 作成したディレクトリとファイルを削除してクリーンアップします。
55        if (is_dir($testDirPath)) {
56            // RecursiveDirectoryIterator と RecursiveIteratorIterator を使用して、
57            // サブディレクトリ内のファイルも含めて安全に削除します。
58            $recursiveIterator = new RecursiveDirectoryIterator(
59                $testDirPath,
60                RecursiveDirectoryIterator::SKIP_DOTS
61            );
62            $files = new RecursiveIteratorIterator(
63                $recursiveIterator,
64                RecursiveIteratorIterator::CHILD_FIRST
65            );
66            foreach ($files as $file) {
67                if ($file->isDir()) {
68                    rmdir($file->getRealPath());
69                } else {
70                    unlink($file->getRealPath());
71                }
72            }
73            rmdir($testDirPath);
74        }
75    }
76
77    echo "---------------------------------------------------\n";
78    echo "デモンストレーション終了。\n";
79}
80
81// 上記のデモンストレーション関数を実行します。
82demonstrateGlobIteratorIsDot();

GlobIterator::isDot()メソッドは、PHPのファイルシステムを走査するGlobIteratorクラスに属しています。このメソッドは、現在イテレータが指しているファイルシステム要素が、特殊なディレクトリである「.」（カレントディレクトリ）または「..」（親ディレクトリ）のどちらかであるかを判定する役割を持ちます。引数は必要なく、現在の要素がこれらの特殊なドットディレクトリであればtrueを、それ以外の通常のファイルやディレクトリであればfalseを真偽値（bool型）で返します。

このメソッドは、ファイルの処理やディレクトリの走査を行う際に非常に有用です。特に、ディレクトリの内容を再帰的に列挙したり、特定の条件に合致するファイルのみを抽出したりする場面で、これらの特殊なドットディレクトリを処理対象から除外することで、予期せぬ動作を防ぎ、効率的かつ安全なファイルシステム操作が可能になります。サンプルコードでは、GlobIteratorを使用してディレクトリ内の要素を順に処理する中で、isDot()メソッドを利用して特殊なドットディレクトリを適切にスキップする具体的な手順を示しており、通常のファイルやディレクトリのみを対象とする処理の流れを確認できます。

Copy
1<?php
2
3/**
4 * GlobIterator::isDot() メソッドの動作をデモンストレーションします。
5 *
6 * この関数は、一時ディレクトリを作成し、その中にテスト用のファイルやサブディレクトリを配置します。
7 * 次に、GlobIterator を使用してディレクトリの内容を反復処理し、
8 * 各エントリが特殊な '.' (カレントディレクトリ) または '..' (親ディレクトリ) の参照であるかどうかを
9 * isDot() メソッドで判定し、結果を出力します。
10 * 処理が完了した後、作成した一時ディレクトリとその内容はクリーンアップされます。
11 *
12 * @param string $tempDirPrefix 一時ディレクトリ名のプレフィックス
13 */
14function demonstrateGlobIteratorIsDot(string $tempDirPrefix = 'php_glob_test_'): void
15{
16    // 1. デモンストレーション用の一時ディレクトリを準備します
17    // システムの一時ディレクトリパスを取得し、ユニークな名前で新しいディレクトリを作成します。
18    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . uniqid($tempDirPrefix);
19    if (!mkdir($tempDir, 0777, true)) {
20        echo "エラー: 一時ディレクトリ '{$tempDir}' の作成に失敗しました。\n";
21        return;
22    }
23
24    // テスト用のファイルとサブディレクトリを作成します
25    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'example.txt', 'Hello PHP!');
26    mkdir($tempDir . DIRECTORY_SEPARATOR . 'subfolder');
27    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'subfolder' . DIRECTORY_SEPARATOR . 'document.pdf', 'PDF content');
28
29    echo "--- GlobIterator::isDot() のデモンストレーション ---\n";
30    echo "対象ディレクトリ: {$tempDir}\n";
31    echo "-----------------------------------------------------\n";
32
33    // 2. GlobIterator を使用してディレクトリ内のエントリを反復処理します
34    // isDot() メソッドの動作を明確に確認するため、glob パターンに明示的に '.' と '..' を含めます。
35    // `{.,..,*,*.*}` は、カレントディレクトリ、親ディレクトリ、すべてのファイルとディレクトリ
36    // （ファイル名のみ、または拡張子付き）をマッチさせます。
37    $globPattern = $tempDir . DIRECTORY_SEPARATOR . '{.,..,*,*.*}';
38
39    // GlobIterator のコンストラクタには、glob() 関数と同じパターンとフラグを渡すことができます。
40    // FilesystemIterator::KEY_AS_PATHNAME: イテレータのキーとしてファイルまたはディレクトリのフルパスを使用します。
41    // FilesystemIterator::CURRENT_AS_FILEINFO: イテレータの値として SplFileInfo オブジェクトを使用します。
42    // GlobIterator::GLOB_BRACE: 波括弧 {} の展開を有効にし、{a,b,c} のようなパターンを使用できるようにします。
43    $iterator = new GlobIterator(
44        $globPattern,
45        FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO | GlobIterator::GLOB_BRACE
46    );
47
48    echo "globパターン '{$globPattern}' を使用して検索されたエントリ:\n";
49    foreach ($iterator as $pathname => $fileInfo) {
50        // SplFileInfo オブジェクト (GlobIterator はこれを返します) は isDot() メソッドを提供します。
51        // isDot() は、現在のエントリが特殊な '.' (カレントディレクトリ) または
52        // '..' (親ディレクトリ) である場合に true を返します。
53        // それ以外の通常ファイルやディレクトリの場合は false を返します。
54        $isDot = $fileInfo->isDot();
55        echo "  - ファイル/ディレクトリ名: " . $fileInfo->getFilename() . " (フルパス: {$pathname}) => isDot(): " . ($isDot ? 'true' : 'false') . "\n";
56    }
57
58    echo "-----------------------------------------------------\n";
59    echo "デモンストレーションが完了しました。\n";
60
61    // 3. 後処理: 作成した一時ディレクトリとファイルを削除します
62    // 再帰的にディレクトリを削除するためのヘルパー関数を定義します。
63    $removeDir = function (string $dir) use (&$removeDir): void {
64        if (!is_dir($dir)) {
65            return;
66        }
67        $files = array_diff(scandir($dir), ['.', '..']);
68        foreach ($files as $file) {
69            $path = $dir . DIRECTORY_SEPARATOR . $file;
70            (is_dir($path)) ? $removeDir($path) : unlink($path);
71        }
72        rmdir($dir);
73    };
74    $removeDir($tempDir);
75    echo "一時ディレクトリ '{$tempDir}' をクリーンアップしました。\n";
76}
77
78// 関数を実行してデモンストレーションを開始します
79demonstrateGlobIteratorIsDot();

PHP 8のGlobIteratorクラスに属するisDot()メソッドは、ファイルシステムを探索する際に、特別なディレクトリ参照である「. (カレントディレクトリ)」や「.. (親ディレクトリ)」を識別するために使用されます。このメソッドは引数を一切取らず、現在のエントリが「.」または「..」のいずれかである場合にtrueを、それ以外の通常のファイルやサブディレクトリである場合にはfalseをブール値 (bool) として返します。

GlobIteratorは、指定されたパターンに合致するファイルやディレクトリを反復処理し、各エントリをSplFileInfoオブジェクトとして提供します。isDot()メソッドは、このSplFileInfoオブジェクトに対して呼び出すことができます。例えば、ディレクトリの内容を一覧表示する際に、「.`」や「..」といったシステム上の特殊なエントリを処理対象から除外したい場合などに大変役立ち、ファイルシステム操作におけるイテレーションの制御や、特定のファイル・ディレクトリのフィルタリングを簡潔に実装することを可能にします。