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

Copy
1<?php
2
3// このスクリプトは、RecursiveDirectoryIterator を使用して指定されたディレクトリ内の
4// 各ファイルやサブディレクトリが読み取り可能であるかをチェックする方法を示します。
5// これはシステムエンジニアを目指す初心者が、ファイルシステム操作とイテレータの
6// 基本を理解するのに役立つシンプルな例です。
7
8// 処理対象とするディレクトリのパスを指定します。
9// __DIR__ は現在のスクリプトが配置されているディレクトリを指します。
10// 実際のアプリケーションでは、任意の有効なディレクトリパスを指定してください。
11$targetDirectory = __DIR__;
12
13try {
14    // RecursiveDirectoryIterator のインスタンスを作成します。
15    // RecursiveDirectoryIterator::SKIP_DOTS フラグは、特殊なディレクトリである '.' と '..' を
16    // イテレーションから除外するために使用されます。これにより出力が簡潔になります。
17    $directoryIterator = new RecursiveDirectoryIterator(
18        $targetDirectory,
19        RecursiveDirectoryIterator::SKIP_DOTS
20    );
21
22    // RecursiveIteratorIterator を使用して、ディレクトリとそのサブディレクトリを再帰的に走査します。
23    // これにより、ディレクトリ内のすべての要素（ファイルとサブディレクトリ）にアクセスできます。
24    $recursiveIterator = new RecursiveIteratorIterator($directoryIterator);
25
26    echo sprintf("ディレクトリ '%s' の読み取り可能性をチェックします:\n", $targetDirectory);
27
28    // 各ファイルまたはディレクトリに対してループ処理を行います。
29    foreach ($recursiveIterator as $fileInfo) {
30        // 現在の要素のパスを取得します。
31        $path = $fileInfo->getPathname();
32
33        // RecursiveDirectoryIterator::isReadable() メソッドを呼び出し、
34        // 現在のファイルまたはディレクトリが読み取り可能であるかを確認します。
35        // このメソッドは、読み取り可能であれば true、そうでなければ false を返します。
36        $isReadable = $fileInfo->isReadable();
37
38        // 結果を整形して出力します。
39        // true/false の結果を「はい」/「いいえ」で表示することで、視覚的に分かりやすくします。
40        echo sprintf(
41            "  パス: %s -> 読み取り可能: %s\n",
42            $path,
43            $isReadable ? 'はい' : 'いいえ'
44        );
45    }
46} catch (UnexpectedValueException $e) {
47    // 指定されたディレクトリが存在しない、またはアクセス権がない場合に発生する例外を処理します。
48    echo sprintf(
49        "エラー: 指定されたディレクトリ '%s' にアクセスできません。詳細: %s\n",
50        $targetDirectory,
51        $e->getMessage()
52    );
53} catch (Exception $e) {
54    // その他の予期せぬエラーが発生した場合に処理します。
55    echo sprintf("予期せぬエラーが発生しました: %s\n", $e->getMessage());
56}
57
58?>

PHPのRecursiveDirectoryIteratorクラスは、指定されたディレクトリとその中のサブディレクトリを再帰的に走査し、ファイルシステム上の各要素にアクセスするための機能を提供します。このクラスのisReadableメソッドは、現在処理中のファイルやディレクトリが、スクリプトを実行しているユーザーから読み取り可能であるかをチェックするために利用されます。

isReadableメソッドは引数を必要とせず、呼び出すだけで対象の読み取り権限を確認します。戻り値はbool型で、要素が読み取り可能であればtrue（真）を、読み取り不可能であればfalse（偽）を返します。

提供されたサンプルコードでは、まずRecursiveDirectoryIteratorとRecursiveIteratorIteratorを組み合わせて、指定されたディレクトリ内のすべてのファイルやサブディレクトリを再帰的に走査しています。そして、ループ処理の中で各要素に対してisReadableメソッドを呼び出し、その読み取り可能性を判定しています。この結果は「はい」または「いいえ」として出力され、どのファイルやディレクトリが読み取り可能であるかを一覧で確認できます。この例は、ファイルシステムのアクセス権限の確認方法や、イテレータを用いたディレクトリ走査の基本を学ぶ上で役立ちます。

Copy
1<?php
2
3// このスクリプトは、RecursiveDirectoryIterator::isReadable() メソッドが
4// ファイルやディレクトリの読み取り可能性をどのように判断するかを示すサンプルです。
5// 特に、読み取り不可能なファイルに対して false を返すケースに焦点を当てています。
6
7// テスト用のディレクトリとファイルを準備します。
8// スクリプトが実行されるディレクトリに一時的なファイルを作成します。
9$testDir = __DIR__ . '/temp_read_test_dir';
10$readableFile = $testDir . '/readable_file.txt';
11$unreadableFile = $testDir . '/unreadable_file.txt';
12$subDir = $testDir . '/sub_directory';
13
14// テストディレクトリが存在しない場合は作成します。
15if (!is_dir($testDir)) {
16    mkdir($testDir);
17}
18// サブディレクトリが存在しない場合は作成します。
19if (!is_dir($subDir)) {
20    mkdir($subDir);
21}
22
23// 読み取り可能なファイルを作成します。
24file_put_contents($readableFile, 'This is a readable file content.');
25
26// 読み取り不可能なファイルを作成し、権限を設定します。
27// UNIX系OSでは、chmod(..., 000) はファイルへのすべてのアクセス（読み取り、書き込み、実行）を禁止します。
28// Windows環境では、この権限設定が意図通りに動作しない場合があるため、isReadable() が常に false を返すとは限りません。
29file_put_contents($unreadableFile, 'This is an unreadable file content.');
30chmod($unreadableFile, 000); // すべてのユーザーに対して読み取り、書き込み、実行権限を削除
31
32echo "RecursiveDirectoryIterator::isReadable() のテストを開始します...\n\n";
33
34try {
35    // RecursiveDirectoryIterator を使用して、指定されたディレクトリを走査します。
36    // RecursiveDirectoryIterator::SKIP_DOTS フラグは "." と ".." のエントリをスキップします。
37    $directoryIterator = new RecursiveDirectoryIterator($testDir, RecursiveDirectoryIterator::SKIP_DOTS);
38
39    // RecursiveIteratorIterator を使用して、ディレクトリ階層全体を再帰的に走査します。
40    // RecursiveIteratorIterator::SELF_FIRST フラグは、サブディレクトリの内容を処理する前に
41    // サブディレクトリ自体を処理します。
42    $iterator = new RecursiveIteratorIterator(
43        $directoryIterator,
44        RecursiveIteratorIterator::SELF_FIRST
45    );
46
47    // ディレクトリ内の各要素（ファイルおよびサブディレクトリ）をループ処理します。
48    foreach ($iterator as $path => $fileInfo) {
49        /** @var SplFileInfo $fileInfo 現在の要素（ファイルまたはディレクトリ）の情報を保持するオブジェクト */
50        echo "パス: " . $fileInfo->getPathname() . "\n";
51        echo "  タイプ: " . ($fileInfo->isDir() ? 'ディレクトリ' : 'ファイル') . "\n";
52
53        // isReadable() メソッドを呼び出し、現在の要素が読み取り可能かどうかを確認します。
54        if ($fileInfo->isReadable()) {
55            echo "  読み取り可能: true\n";
56        } else {
57            // 意図的に読み取り不可にしたファイル (unreadable_file.txt) に対しては、
58            // ここで false が出力されることを期待します。
59            echo "  読み取り可能: false (unreadable_file.txt に対しては期待される結果です)\n";
60        }
61        echo "\n";
62    }
63
64} catch (RuntimeException $e) {
65    // RecursiveDirectoryIterator の初期化中にエラーが発生した場合（例: 指定されたディレクトリが存在しない）
66    echo "エラーが発生しました: " . $e->getMessage() . "\n";
67} finally {
68    // テスト後に作成したディレクトリとファイルをクリーンアップします。
69    // 読み取り不可能なファイルを削除するには、まずその権限を元に戻す必要があります。
70    if (file_exists($unreadableFile)) {
71        chmod($unreadableFile, 0644); // 削除できるように読み取り・書き込み権限を付与
72        unlink($unreadableFile);
73    }
74    if (file_exists($readableFile)) {
75        unlink($readableFile);
76    }
77    if (is_dir($subDir)) {
78        rmdir($subDir); // サブディレクトリを削除
79    }
80    // ディレクトリ内のすべてのファイルが削除されていれば、ディレクトリ自体も削除できます。
81    if (is_dir($testDir)) {
82        rmdir($testDir); // テストディレクトリを削除
83    }
84    echo "テスト環境のクリーンアップが完了しました。\n";
85}

PHPのRecursiveDirectoryIteratorクラスに属するisReadable()メソッドは、ファイルシステム上の特定のパスにあるファイルやディレクトリが読み取り可能かどうかを判定します。このメソッドは引数を一切取らず、判定結果を真偽値（bool）として返します。

戻り値がtrueの場合、対象が読み取り可能であることを示し、falseの場合は読み取り不可能であることを示します。特に、ファイルに読み取り権限が設定されていない場合など、アクセスが制限されている状況ではfalseが返されます。

提供されたサンプルコードでは、一時的なディレクトリとファイルを作成し、その中に意図的に読み取り権限が削除されたファイル（unreadable_file.txt）を用意しています。RecursiveDirectoryIteratorとRecursiveIteratorIteratorを使ってディレクトリ内を走査する際に、isReadable()メソッドを呼び出すことで、この読み取り不可能なファイルに対してfalseが正しく返されることを確認できます。これにより、システムエンジニアを目指す方が、ファイル操作前にファイルの読み取り可能性をプログラムで安全に確認する方法を理解し、エラーハンドリングを考慮した堅牢なアプリケーション開発に役立てることができます。