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

Copy
1<?php
2
3/**
4 * 指定されたディレクトリ内のコンテンツを一覧表示し、
5 * 各エントリがディレクトリであるかファイルであるかを判定します。
6 *
7 * @param string $path 調査するディレクトリのパス
8 */
9function listDirectoryContents(string $path): void
10{
11    echo "ディレクトリ '{$path}' の内容:\n";
12
13    try {
14        // DirectoryIterator をインスタンス化し、指定されたパスのディレクトリを読み込みます。
15        // これにより、ディレクトリ内の各エントリを順番に処理できるようになります。
16        $iterator = new DirectoryIterator($path);
17
18        // foreach ループを使用して、ディレクトリ内の各エントリを処理します。
19        // $fileInfo は DirectoryIterator オブジェクトの各エントリ（ファイルまたはサブディレクトリ）を表します。
20        foreach ($iterator as $fileInfo) {
21            // エントリのファイル名またはディレクトリ名を取得します。
22            $name = $fileInfo->getFilename();
23
24            // isDir() メソッドを使用して、現在のエントリがディレクトリであるかを判定します。
25            // isDir() は引数なしで呼び出され、結果として true (ディレクトリの場合) または false (ファイルの場合) を返します。
26            if ($fileInfo->isDir()) {
27                // エントリがディレクトリである場合の処理
28                echo "  [D] " . $name . " (ディレクトリ)\n";
29            } else {
30                // エントリがファイルである場合の処理
31                echo "  [F] " . $name . " (ファイル)\n";
32            }
33        }
34    } catch (UnexpectedValueException $e) {
35        // 指定されたパスが無効なディレクトリであるか、またはアクセス権がない場合に発生する例外を捕捉します。
36        echo "エラー: 指定されたパス '{$path}' は無効なディレクトリであるか、アクセスできません。\n";
37        echo "詳細: " . $e->getMessage() . "\n";
38    }
39}
40
41// このスクリプトが実行されているカレントディレクトリを対象とします。
42// 例として、このPHPファイルと同じディレクトリ内のファイルやサブディレクトリが一覧表示されます。
43$currentDirectory = __DIR__;
44
45// 関数を呼び出して、カレントディレクトリの内容を表示します。
46listDirectoryContents($currentDirectory);
47
48// 必要に応じて、他のディレクトリを試すこともできます。
49// 例: listDirectoryContents('/tmp'); // Linux/macOS の場合
50// 例: listDirectoryContents('C:\\Windows'); // Windows の場合
51?>

このサンプルコードは、指定されたディレクトリ内のファイルやサブディレクトリを一覧表示し、それぞれがディレクトリなのかファイルなのかを判定して表示するプログラムです。

まず、DirectoryIteratorクラスは、指定されたディレクトリの内容を一つずつ順番に読み込むための機能を提供します。サンプルコードでは、このDirectoryIteratorを使ってディレクトリ内の各項目（エントリ）にアクセスし、foreachループで順に処理しています。

ループの中で使用されている$fileInfo->isDir()メソッドは、現在処理しているエントリが「ディレクトリ」であるかどうかを判定するものです。このisDir()メソッドは引数を必要とせず、呼び出すだけで機能します。戻り値はbool型で、エントリがディレクトリであればtrueを、ファイルであればfalseを返します。

サンプルコードでは、このisDir()メソッドの戻り値を利用してif文で条件分岐を行っています。isDir()がtrueを返せば「ディレクトリ」として、falseを返せば「ファイル」として、それぞれ適切な表示を行うことで、ディレクトリの内容を分かりやすく伝えています。もし指定されたパスが無効な場合やアクセス権がない場合は、例外処理によりエラーメッセージが表示されます。

Copy
1<?php
2
3/**
4 * 指定されたディレクトリの内容を走査し、各項目がディレクトリであるかファイルであるかを表示します。
5 * DirectoryIterator::isDir() メソッドの使用例を示します。
6 *
7 * @param string $directoryPath 走査するディレクトリのパス
8 * @return void
9 */
10function listDirectoryContents(string $directoryPath): void
11{
12    // ディレクトリが存在し、アクセス可能であることを確認します。
13    if (!is_dir($directoryPath)) {
14        echo "エラー: '{$directoryPath}' は有効なディレクトリではありません。\n";
15        return;
16    }
17
18    echo "--- ディレクトリ '{$directoryPath}' の内容 --- \n";
19
20    try {
21        // DirectoryIterator のインスタンスを作成し、指定されたパスを反復処理できるようにします。
22        $iterator = new DirectoryIterator($directoryPath);
23
24        // ディレクトリ内の各項目（ファイルまたはディレクトリ）を反復処理します。
25        foreach ($iterator as $item) {
26            // isDir() メソッドを使用して、現在の項目がディレクトリであるかどうかを判断します。
27            if ($item->isDir()) {
28                // ディレクトリの場合、[D] として表示します。
29                echo "[D] " . $item->getFilename() . "\n";
30            } else {
31                // ディレクトリでない場合（通常はファイル）、[F] として表示します。
32                echo "[F] " . $item->getFilename() . "\n";
33            }
34        }
35    } catch (UnexpectedValueException $e) {
36        // ディレクトリへのアクセスに問題がある場合（例: 権限不足）のエラーを処理します。
37        echo "エラー: ディレクトリにアクセスできませんでした: {$e->getMessage()}\n";
38    }
39
40    echo "--- 走査完了 --- \n";
41}
42
43// --- デモンストレーションのセットアップ ---
44// このスクリプトと同じディレクトリ内に一時的なディレクトリとファイルを作成し、
45// isDir() の動作を明確に示します。
46$currentDir = __DIR__;
47$tempDirPath = $currentDir . DIRECTORY_SEPARATOR . 'temp_demo_dir';
48$tempFilePath = $currentDir . DIRECTORY_SEPARATOR . 'temp_demo_file.txt';
49
50// 一時ディレクトリが存在しない場合は作成します。
51if (!is_dir($tempDirPath)) {
52    mkdir($tempDirPath);
53    echo "一時ディレクトリを作成しました: {$tempDirPath}\n";
54}
55
56// 一時ファイルが存在しない場合は作成します。
57if (!file_exists($tempFilePath)) {
58    file_put_contents($tempFilePath, 'これはデモンストレーション用のダミーファイルです。');
59    echo "一時ファイルを作成しました: {$tempFilePath}\n";
60}
61
62// 現在のスクリプトがあるディレクトリの内容をリスト表示する関数を呼び出します。
63// これにより、作成した 'temp_demo_dir' が [D] として、'temp_demo_file.txt' が [F] として表示されます。
64listDirectoryContents($currentDir);
65
66// --- クリーンアップ ---
67// デモンストレーション後に作成した一時ファイルとディレクトリを削除します。
68if (file_exists($tempFilePath)) {
69    unlink($tempFilePath);
70    echo "一時ファイルを削除しました: {$tempFilePath}\n";
71}
72if (is_dir($tempDirPath)) {
73    rmdir($tempDirPath);
74    echo "一時ディレクトリを削除しました: {$tempDirPath}\n";
75}
76
77?>

PHPのDirectoryIterator::isDir()メソッドは、ファイルシステム上の特定の項目がディレクトリ（フォルダ）であるかどうかを判定するために使用されます。このメソッドはDirectoryIteratorクラスのオブジェクトに対して呼び出すことができ、引数は不要です。戻り値はブール値（bool）で、対象の項目がディレクトリであればtrueを、ファイルやその他の項目であればfalseを返します。

サンプルコードでは、まず指定されたディレクトリのパスからDirectoryIteratorのインスタンスを作成し、そのディレクトリ内の各項目を順に処理しています。ループの中で$item->isDir()が呼び出され、このメソッドがtrueを返すとその項目はディレクトリであると判断され[D]と表示されます。一方、falseが返されるとファイルとして扱われ[F]と表示されるため、各項目の種類を明確に区別してリスト表示できる様子がわかります。ファイルシステムを走査し、ファイルとディレクトリに応じて異なる処理を行いたい場合に、このisDir()メソッドは非常に役立ちます。