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

Copy
1<?php
2
3// 一時的なテストディレクトリとファイルを作成するための準備
4$tempDir = __DIR__ . '/temp_glob_test_dir';
5$tempFile = $tempDir . '/temp_file.txt';
6$tempSubDir = $tempDir . '/temp_subdir';
7
8// スクリプト終了時に作成した一時ファイルをクリーンアップします。
9register_shutdown_function(function() use ($tempDir, $tempFile, $tempSubDir) {
10    if (file_exists($tempFile)) {
11        unlink($tempFile);
12    }
13    if (is_dir($tempSubDir)) {
14        rmdir($tempSubDir);
15    }
16    if (is_dir($tempDir)) {
17        rmdir($tempDir);
18    }
19});
20
21// テスト用のディレクトリとファイルを作成します。
22if (!is_dir($tempDir)) {
23    mkdir($tempDir);
24}
25if (!file_exists($tempFile)) {
26    file_put_contents($tempFile, 'Sample content.');
27}
28if (!is_dir($tempSubDir)) {
29    mkdir($tempSubDir);
30}
31
32echo "GlobIterator::isDir() メソッドの使用例:\n";
33echo "走査対象パス: " . $tempDir . "/*\n\n";
34
35try {
36    // GlobIterator を使用して、指定されたパターンに一致するファイルやディレクトリを走査します。
37    // FilesystemIterator::KEY_AS_PATHNAME はイテレータのキーをフルパスとして、
38    // FilesystemIterator::CURRENT_AS_FILEINFO はイテレータの値を SplFileInfo オブジェクトとして取得します。
39    // GlobIterator が返す各要素は SplFileInfo のインスタンスであり、isDir() メソッドを持ちます。
40    $iterator = new GlobIterator(
41        $tempDir . '/*',
42        FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO
43    );
44
45    // イテレータをループし、各要素がディレクトリであるかを確認します。
46    foreach ($iterator as $path => $fileInfo) {
47        // $fileInfo (SplFileInfo オブジェクト) の isDir() メソッドを呼び出し、
48        // その要素がディレクトリであれば true、そうでなければ false を返します。
49        if ($fileInfo->isDir()) {
50            echo "[ディレクトリ] " . $path . "\n";
51        } else {
52            echo "[ファイル]     " . $path . "\n";
53        }
54    }
55} catch (UnexpectedValueException $e) {
56    // 無効なパターンが指定された場合などに発生する例外をキャッチします。
57    echo "エラーが発生しました: " . $e->getMessage() . "\n";
58}
59
60echo "\nサンプルコード実行完了。\n";

GlobIterator::isDir()メソッドは、PHPでファイルシステムを走査する際に、特定の要素がディレクトリであるかどうかを判別するために使用されます。

GlobIteratorは、指定されたパターンに一致するファイルやディレクトリを効率的に見つけて、順に処理するためのイテレータ（反復子）です。このイテレータが返す各要素は、SplFileInfoというオブジェクトのインスタンスです。SplFileInfoオブジェクトは、ファイルやディレクトリに関する様々な情報を提供し、その一つとしてisDir()メソッドを持っています。

isDir()メソッドは、引数を一切取らず、現在のSplFileInfoオブジェクトが表すパスがディレクトリであればtrue（真）を、ファイルなどディレクトリ以外であればfalse（偽）をブール値として返します。

サンプルコードでは、まず一時的なディレクトリとファイルを準備しています。その後、GlobIteratorを使って作成した一時ディレクトリ内のコンテンツを走査し、foreachループ内で各要素のisDir()メソッドを呼び出しています。これにより、現在処理している要素がディレクトリなのかファイルなのかを判別し、その結果に基づいてメッセージを分けて表示しています。このメソッドは、ファイルシステム内の要素の種類を識別し、それぞれに応じた処理を行う際に非常に便利です。

Copy
1<?php
2
3// サンプル実行のための一時ディレクトリとファイルを作成
4$tempDir = __DIR__ . '/temp_glob_test_' . uniqid('glob_example_');
5if (!mkdir($tempDir) && !is_dir($tempDir)) {
6    throw new \RuntimeException(sprintf('Directory "%s" was not created', $tempDir));
7}
8file_put_contents($tempDir . '/file_a.txt', 'This is a test file.');
9mkdir($tempDir . '/dir_b');
10file_put_contents($tempDir . '/dir_b/file_c.txt', 'Another test file.');
11
12echo "--- GlobIterator::isDir() の使用例 ---" . PHP_EOL;
13echo "作成された一時ディレクトリ: " . basename($tempDir) . PHP_EOL;
14echo "このディレクトリ内の要素をチェックします。" . PHP_EOL . PHP_EOL;
15
16try {
17    // GlobIterator を使用して、指定されたパターンに一致するエントリを反復処理します。
18    // ここでは、一時ディレクトリ内のすべてのファイルとディレクトリ（`*`）を対象とします。
19    $iterator = new GlobIterator($tempDir . '/*');
20
21    // イテレータをループし、各エントリに対して `isDir()` メソッドを呼び出します。
22    foreach ($iterator as $name => $fileInfo) {
23        // SplFileInfo オブジェクトからパス名を取得
24        $path = $fileInfo->getPathname();
25        
26        // isDir() メソッドを呼び出して、現在のエントリがディレクトリであるかをチェック
27        $isDir = $fileInfo->isDir();
28
29        echo sprintf(
30            "エントリ: \"%s\" はディレクトリですか？ %s%s",
31            basename($path),
32            $isDir ? 'はい' : 'いいえ',
33            PHP_EOL
34        );
35    }
36} catch (Exception $e) {
37    echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
38} finally {
39    // 後処理：サンプル実行のために作成した一時ディレクトリとファイルを削除
40    if (file_exists($tempDir)) {
41        // ディレクトリを再帰的に削除するためのヘルパー関数
42        $deleteRecursive = function ($dir) use (&$deleteRecursive) {
43            $files = array_diff(scandir($dir), ['.', '..']);
44            foreach ($files as $file) {
45                (is_dir("$dir/$file")) ? $deleteRecursive("$dir/$file") : unlink("$dir/$file");
46            }
47            return rmdir($dir);
48        };
49        $deleteRecursive($tempDir);
50        echo PHP_EOL . "--- 一時ファイルをクリーンアップしました ---" . PHP_EOL;
51    }
52}
53
54?>

PHPのGlobIterator::isDir()メソッドは、ファイルシステム上の要素を反復処理する際に、現在注目している要素がディレクトリであるかどうかを判定するために使用されます。このメソッドは、GlobIteratorが返すSplFileInfoオブジェクトに対して呼び出されます。

isDir()メソッドは引数を必要としません。戻り値はブール値（bool）で、現在の要素がディレクトリであればtrue（真）を返し、ファイルやシンボリックリンクなどのディレクトリ以外のものであればfalse（偽）を返します。

システムエンジニアがファイルやディレクトリを扱うプログラムを構築する際、特定の操作をディレクトリにのみ適用したい場合や、ファイルとディレクトリで処理を区別したい場合に、このメソッドは大変有効です。

サンプルコードでは、一時的に作成されたディレクトリ内のエントリをGlobIteratorで一つずつ取得し、それぞれの要素がディレクトリであるかをisDir()メソッドを使って判別しています。例えば、「file_a.txt」のようなファイルは「いいえ」と判定され、「dir_b」のようなディレクトリは「はい」と判定されます。このように、isDir()を利用することで、反復処理中にファイルとディレクトリを正確に区別し、それぞれの種類に応じた適切な処理を柔軟に適用できるようになります。