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

Copy
1<?php
2
3/**
4 * 指定されたディレクトリ内の各エントリ（ファイルやサブディレクトリ）が
5 * 読み取り可能であるかを判定し、その結果を表示する関数です。
6 *
7 * この関数は DirectoryIterator クラスとその isReadable メソッドの使用例を示します。
8 * isReadable は、現在のイテレータが指すエントリ（ファイルまたはディレクトリ）が
9 * スクリプトによって読み取り可能である場合に true を返します。
10 *
11 * @param string $directoryPath 走査対象のディレクトリへのパス
12 * @return void
13 */
14function checkReadabilityOfDirectoryEntries(string $directoryPath): void
15{
16    echo "ディレクトリ '{$directoryPath}' 内の読み取り可能性をチェックします:\n";
17
18    try {
19        // DirectoryIterator オブジェクトを作成します。
20        // これにより、指定されたディレクトリ内のすべてのエントリを反復処理できます。
21        $iterator = new DirectoryIterator($directoryPath);
22
23        // ディレクトリ内の各エントリをループ処理します。
24        foreach ($iterator as $fileInfo) {
25            // 現在のエントリ（ファイルまたはディレクトリ）の名前を取得します。
26            $entryName = $fileInfo->getFilename();
27
28            // isReadable() メソッドを使用して、このエントリが読み取り可能かを確認します。
29            // 戻り値は bool (true または false) です。
30            $isReadable = $fileInfo->isReadable();
31
32            // 結果を整形して出力します。
33            $status = $isReadable ? "はい" : "いいえ";
34            echo "  - {$entryName}: 読み取り可能? {$status}\n";
35        }
36    } catch (UnexpectedValueException $e) {
37        // 指定されたパスがディレクトリでない場合や存在しない場合に発生する例外をキャッチします。
38        echo "エラー: '{$directoryPath}' は有効なディレクトリではありません。詳細: " . $e->getMessage() . "\n";
39    }
40}
41
42// サンプルとして、このスクリプトが実行されているカレントディレクトリをチェックします。
43// 必要に応じて、他のディレクトリパス（例: '/var/log' や 'C:\Windows\System32' など）を
44// 引数に指定して試すこともできますが、そのディレクトリに対する読み取り権限が必要です。
45$currentDirectory = '.';
46checkReadabilityOfDirectoryEntries($currentDirectory);
47
48?>

PHP 8のDirectoryIteratorクラスに属するisReadableメソッドは、ファイルやディレクトリが現在のスクリプトから読み取り可能かどうかを判定するために使用されます。このメソッドは引数を一切持たず、対象のエントリが読み取り可能であればtrueを、そうでなければfalseをブール値として返します。

提供されたサンプルコードでは、まずDirectoryIteratorを使って指定されたディレクトリ内の各エントリ（ファイルやサブディレクトリ）を一つずつ反復処理しています。ループ内で、各エントリの情報を持つオブジェクトに対してisReadable()メソッドを呼び出すことで、そのエントリが読み取り可能であるかをプログラム的に確認し、その結果を「はい」または「いいえ」で表示しています。これにより、ファイルやディレクトリへのアクセス権限を事前にチェックでき、スクリプトが安全に動作するための確認に役立ちます。また、指定されたパスが無効なディレクトリだった場合には、try-catch文で例外を捕捉し、適切なエラーメッセージを表示するように設計されています。

Copy
1<?php
2
3/**
4 * DirectoryIterator::isReadable() メソッドのサンプルコード
5 *
6 * この関数は、指定されたディレクトリ内のファイルが読み取り可能かどうかをチェックします。
7 * isReadable() が false を返すケースを示すために、一時的に読み取り不可なファイルを
8 * 作成し、その後クリーンアップします。
9 *
10 * システムエンジニアを目指す初心者向けに、ファイルシステムのアクセス権限が
11 * プログラムの動作にどのように影響するかを示します。
12 */
13function demonstrateDirectoryIteratorIsReadable(): void
14{
15    // 1. 一時ディレクトリを作成
16    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . uniqid('php_readable_test_');
17    if (!mkdir($tempDir, 0777, true)) {
18        echo "エラー: 一時ディレクトリ '$tempDir' の作成に失敗しました。\n";
19        return;
20    }
21    echo "一時ディレクトリを作成しました: $tempDir\n\n";
22
23    // 2. 読み取り可能な一時ファイルを作成
24    $readableFilePath = $tempDir . DIRECTORY_SEPARATOR . 'readable_file.txt';
25    file_put_contents($readableFilePath, 'これは読み取り可能なファイルです。');
26    // ファイルのパーミッションを0644に設定 (オーナーは読み書き可能、グループとその他は読み取りのみ)
27    chmod($readableFilePath, 0644); 
28    echo "ファイルを作成しました: $readableFilePath (パーミッション: 0644)\n";
29
30    // 3. 読み取り不可能な一時ファイルを作成
31    $unreadableFilePath = $tempDir . DIRECTORY_SEPARATOR . 'unreadable_file.txt';
32    file_put_contents($unreadableFilePath, 'これは読み取り不可能なファイルです。');
33    // ファイルのパーミッションを000に設定 (誰も読み書き実行不可)
34    // この設定はUNIX系OS (Linux/macOS) で isReadable が false を返すことを意図しています。
35    // Windows環境ではchmodの動作がUNIX系OSと異なる場合があります。
36    chmod($unreadableFilePath, 000); 
37    echo "ファイルを作成しました: $unreadableFilePath (パーミッション: 000)\n\n";
38
39    try {
40        // 4. DirectoryIterator を使用して一時ディレクトリを反復処理
41        $iterator = new DirectoryIterator($tempDir);
42
43        echo "ディレクトリ '$tempDir' 内のファイル読み取り可能性をチェックします:\n";
44        foreach ($iterator as $fileinfo) {
45            // '.' と '..' (現在のディレクトリと親ディレクトリ) はスキップ
46            if ($fileinfo->isDot()) {
47                continue;
48            }
49
50            $filename = $fileinfo->getFilename();
51            // isReadable() メソッドでファイルが読み取り可能かチェック
52            if ($fileinfo->isReadable()) {
53                echo " - '$filename': 読み取り可能です。\n";
54            } else {
55                echo " - '$filename': 読み取り不可能です。(キーワード: php is_readable false)\n";
56            }
57        }
58    } catch (RuntimeException $e) {
59        echo "エラー: ディレクトリの読み込み中に問題が発生しました: " . $e->getMessage() . "\n";
60    } finally {
61        // 5. 後処理: 作成した一時ファイルとディレクトリを削除
62        echo "\n一時ファイルをクリーンアップしています...\n";
63        if (file_exists($readableFilePath)) {
64            unlink($readableFilePath);
65        }
66        if (file_exists($unreadableFilePath)) {
67            unlink($unreadableFilePath);
68        }
69        if (is_dir($tempDir)) {
70            rmdir($tempDir);
71        }
72        echo "クリーンアップが完了しました。\n";
73    }
74}
75
76// 関数の実行
77demonstrateDirectoryIteratorIsReadable();
78

PHP 8のDirectoryIterator::isReadable()メソッドは、ファイルシステム上の特定のファイルやディレクトリが、現在のプログラムから読み取り可能であるかを判定する際に使用されます。このメソッドは引数を必要とせず、読み取り可能であればtrueを、不可能であればfalseという真偽値を返します。システムエンジニアを目指す上で、プログラムがファイルシステムへアクセスする際の権限管理は非常に重要です。

提供されたサンプルコードでは、一時的に作成したファイルに対して異なるアクセス権限を設定し、isReadable()メソッドの挙動を確認しています。特に、パーミッションを誰も読み書きできない状態（例: 000）に設定したファイルでは、isReadable()はfalseを返し、プログラムがそのファイルの内容を読み取れないことを明確に示します。これにより、ファイルアクセス権限がプログラムの正常な動作にどう影響するかを具体的に理解できます。ファイルが読み取り不可能と判定されたケースでは、「php is_readable false」のキーワードに該当する状況が発生していることを示しています。この機能は、ファイル操作を行うアプリケーションの堅牢性を高めるために不可欠なチェックです。