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

Copy
1<?php
2
3/**
4 * FilesystemIterator::isReadable() メソッドの使用例を示すクラスです。
5 *
6 * このクラスは、一時的なディレクトリとファイルを作成し、
7 * FilesystemIterator を使用してそれらを走査し、
8 * 各エントリが読み取り可能かどうかを isReadable() メソッドでチェックする方法を示します。
9 * システムエンジニアを目指す初心者の方にも理解しやすいように、
10 * 簡潔で単体で動作可能なコードとしています。
11 */
12class FilesystemReadableDemo
13{
14    /** @var string テスト用に作成する一時ディレクトリのパス */
15    private string $testDirectoryPath;
16
17    /**
18     * コンストラクタで一時ディレクトリのパスを決定します。
19     */
20    public function __construct()
21    {
22        // スクリプトが実行されているディレクトリに一時ディレクトリを作成します。
23        // uniqid() を使用して、ユニークなディレクトリ名を生成します。
24        $baseDir = __DIR__;
25        $this->testDirectoryPath = $baseDir . DIRECTORY_SEPARATOR . 'fs_read_demo_' . uniqid();
26    }
27
28    /**
29     * デモンストレーションを実行します。
30     * 一時ディレクトリとファイルを作成し、読み取り可能性をチェックし、
31     * 最後にクリーンアップを行います。
32     */
33    public function run(): void
34    {
35        try {
36            $this->createTestEnvironment();
37            $this->checkReadability();
38        } catch (RuntimeException $e) {
39            echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
40        } finally {
41            $this->cleanupTestEnvironment();
42        }
43    }
44
45    /**
46     * テスト用のディレクトリとファイルを作成します。
47     *
48     * @throws RuntimeException ディレクトリやファイルの作成に失敗した場合にスローされます。
49     */
50    private function createTestEnvironment(): void
51    {
52        // 一時ディレクトリを作成します。
53        // 0755 はディレクトリのパーミッション (所有者:rwx, グループ:rx, その他:rx) です。
54        // true は親ディレクトリが存在しない場合に作成することを意味します。
55        if (!mkdir($this->testDirectoryPath, 0755, true)) {
56            throw new RuntimeException("一時ディレクトリの作成に失敗しました: " . $this->testDirectoryPath);
57        }
58        echo "一時ディレクトリを作成しました: " . $this->testDirectoryPath . PHP_EOL;
59
60        // 読み取り可能なファイルを2つ作成します。
61        // デフォルトのパーミッション (0644) であれば、通常は読み取り可能です。
62        $file1Path = $this->testDirectoryPath . DIRECTORY_SEPARATOR . 'sample_file_1.txt';
63        if (file_put_contents($file1Path, 'これは最初のサンプルファイルです。') === false) {
64            throw new RuntimeException("ファイルの作成に失敗しました: " . $file1Path);
65        }
66
67        $file2Path = $this->testDirectoryPath . DIRECTORY_SEPARATOR . 'sample_file_2.log';
68        if (file_put_contents($file2Path, 'これは2番目のサンプルファイルです。') === false) {
69            throw new RuntimeException("ファイルの作成に失敗しました: " . $file2Path);
70        }
71
72        echo "テスト用ファイルを一時ディレクトリに作成しました。\n";
73    }
74
75    /**
76     * FilesystemIterator を使用して、作成した一時ディレクトリ内の各エントリの
77     * 読み取り可能性をチェックし、結果を表示します。
78     */
79    private function checkReadability(): void
80    {
81        echo "\n--- FilesystemIterator で読み取り可能性をチェック ---" . PHP_EOL;
82        echo "ディレクトリ内の各エントリについて、isReadable() メソッドの結果を表示します。\n";
83
84        try {
85            // FilesystemIterator をインスタンス化し、一時ディレクトリを走査します。
86            // FilesystemIterator は、ディレクトリ内のファイルやサブディレクトリを反復処理できます。
87            // FilesystemIterator::SKIP_DOTS は、特殊なエントリ '.' (カレントディレクトリ) と '..' (親ディレクトリ) をスキップします。
88            $iterator = new FilesystemIterator($this->testDirectoryPath, FilesystemIterator::SKIP_DOTS);
89
90            foreach ($iterator as $fileInfo) {
91                // SplFileInfo オブジェクトの isReadable() メソッドを呼び出し、
92                // 現在のエントリ (ファイルまたはディレクトリ) が読み取り可能かどうかをチェックします。
93                $isReadable = $fileInfo->isReadable();
94
95                // 結果を整形して出力します。
96                echo sprintf(
97                    "- %s (%s): %s\n",
98                    $fileInfo->getFilename(), // エントリの名前
99                    $fileInfo->isDir() ? 'ディレクトリ' : 'ファイル', // エントリの種類
100                    $isReadable ? '読み取り可能' : '読み取り不可' // 読み取り可能性の結果
101                );
102            }
103        } catch (UnexpectedValueException $e) {
104            // ディレクトリが存在しない、またはアクセス権がない場合に発生することがあります。
105            echo "エラー: ディレクトリの走査中に問題が発生しました: " . $e->getMessage() . PHP_EOL;
106        }
107    }
108
109    /**
110     * 作成した一時ディレクトリとその内容をすべて削除し、クリーンアップします。
111     */
112    private function cleanupTestEnvironment(): void
113    {
114        // ディレクトリが存在しない場合は何もしません。
115        if (!is_dir($this->testDirectoryPath)) {
116            return;
117        }
118
119        echo "\n--- クリーンアップ中 ---" . PHP_EOL;
120        try {
121            // ディレクトリ内のすべてのファイルとサブディレクトリを削除します。
122            // ここでも FilesystemIterator::SKIP_DOTS を使用して '.' と '..' を除外します。
123            $iterator = new FilesystemIterator($this->testDirectoryPath, FilesystemIterator::SKIP_DOTS);
124            foreach ($iterator as $fileInfo) {
125                if ($fileInfo->isDir()) {
126                    // サブディレクトリが存在する場合、再帰的に削除する必要がありますが、
127                    // この例ではサブディレクトリを作成していないため、直接 rmdir() を使用します。
128                    rmdir($fileInfo->getPathname());
129                } else {
130                    // ファイルを削除します。
131                    unlink($fileInfo->getPathname());
132                }
133            }
134            // 空になった一時ディレクトリを削除します。
135            rmdir($this->testDirectoryPath);
136            echo "一時ディレクトリとその内容をクリーンアップしました: " . $this->testDirectoryPath . PHP_EOL;
137        } catch (Throwable $e) {
138            // ファイルがロックされているなどで削除できない可能性もあるため、エラーを補足します。
139            echo "クリーンアップ中にエラーが発生しました: " . $e->getMessage() . PHP_EOL;
140            echo "手動で削除する必要があるかもしれません: " . $this->testDirectoryPath . PHP_EOL;
141        }
142    }
143}
144
145// FilesystemReadableDemo クラスのインスタンスを作成し、デモンストレーションを実行します。
146$demo = new FilesystemReadableDemo();
147$demo->run();

PHP 8のFilesystemIterator::isReadable()メソッドは、ファイルシステム上の特定のパスが、現在のスクリプトから読み取り可能であるかを判定するために使用されます。このメソッドは、FilesystemIteratorがディレクトリを走査した際に取得できるSplFileInfoオブジェクトから呼び出されます。引数はなく、戻り値は真偽値（trueまたはfalse）です。読み取り可能であればtrueを、そうでなければfalseを返しますので、ファイルの内容を読み込む前や、ディレクトリ内のファイルを処理する前に安全にアクセス可能かを確認できます。

提供されたサンプルコードでは、まず一時的なディレクトリとファイルを準備し、次にFilesystemIteratorを用いてそのディレクトリ内の各エントリ（ファイルやサブディレクトリ）を一つずつ走査します。走査中に取得されるSplFileInfoオブジェクトに対してisReadable()メソッドを呼び出し、そのエントリが読み取り可能であるかを判定し、結果を表示しています。この一連の処理は、ファイルシステム操作における基本的な安全確認の手順と、FilesystemIteratorを活用した効率的なディレクトリ走査方法を学ぶ上で役立ち、システムの安定稼働に繋がる堅牢なファイル処理の実装に貢献します。

Copy
1<?php
2
3/**
4 * FilesystemIterator::isReadable() の使用例を示します。
5 * 読み込み権限のないファイルを意図的に作成し、isReadable() メソッドが false を返すことを確認します。
6 * このコードは、Linux/Unix系のファイルシステム権限設定を想定しています。
7 */
8function demonstrateFilesystemIteratorIsReadable(): void
9{
10    // 一時ディレクトリの準備
11    // システムの一時ディレクトリ内に、一意の名前のテスト用ディレクトリを作成します。
12    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_fs_test_' . uniqid();
13    mkdir($tempDir, 0755, true); // 0755権限でディレクトリを作成
14
15    // 1. 読み込み可能なファイルの作成
16    $readableFilePath = $tempDir . DIRECTORY_SEPARATOR . 'can_read.txt';
17    file_put_contents($readableFilePath, 'このファイルは読み込み可能です。');
18    chmod($readableFilePath, 0644); // 読み込み可能権限 (所有者: RW, グループ: R, その他: R)
19
20    // 2. 読み込み不可能なファイルの作成
21    $unreadableFilePath = $tempDir . DIRECTORY_SEPARATOR . 'no_read.txt';
22    file_put_contents($unreadableFilePath, 'このファイルは読み込み不可能です。');
23    // 権限を 0000 に設定。これにより、PHPプロセスを含むすべてのユーザーはこのファイルを読み取れなくなります。
24    // Windows環境では、chmodの挙動がLinux/Unix系OSと異なるため、この動作が保証されない場合があります。
25    chmod($unreadableFilePath, 0000);
26
27    echo "--- FilesystemIterator::isReadable() の使用例 ---" . PHP_EOL;
28    echo "テストディレクトリ: {$tempDir}" . PHP_EOL . PHP_EOL;
29
30    try {
31        // FilesystemIterator を使用してディレクトリを走査します。
32        // これにより、ディレクトリ内の各ファイルやディレクトリの情報にアクセスできます。
33        $iterator = new FilesystemIterator($tempDir);
34
35        foreach ($iterator as $fileInfo) {
36            $filename = $fileInfo->getFilename();
37            $isReadable = $fileInfo->isReadable(); // ファイルが読み込み可能かチェックします。
38
39            echo "ファイル名: {$filename}" . PHP_EOL;
40            echo "パス: {$fileInfo->getPathname()}" . PHP_EOL;
41            echo "読み込み可能: " . ($isReadable ? "true" : "false") . PHP_EOL;
42
43            // キーワード「php is_readable false」に関連する、読み込み不可能なケースを強調表示します。
44            if (!$isReadable) {
45                echo "  --> このファイルは読み込み権限がないため、読み込みできません。" . PHP_EOL;
46            }
47            echo PHP_EOL;
48        }
49
50    } catch (UnexpectedValueException $e) {
51        // 指定されたパスがディレクトリでない場合や、アクセス権がない場合に発生する可能性があります。
52        echo "エラー: ディレクトリが見つからないか、アクセスできません。" . PHP_EOL;
53        echo $e->getMessage() . PHP_EOL;
54    } finally {
55        // 後処理: テストで作成したファイルとディレクトリを削除し、システムをクリーンアップします。
56        // 読み込み不可能なファイルを削除するために、一時的に権限を戻す必要があります。
57        if (file_exists($unreadableFilePath)) {
58            chmod($unreadableFilePath, 0644); // 削除できるように権限を一時的に変更
59            unlink($unreadableFilePath);
60        }
61        if (file_exists($readableFilePath)) {
62            unlink($readableFilePath);
63        }
64        if (file_exists($tempDir)) {
65            rmdir($tempDir);
66        }
67        echo "テストディレクトリをクリーンアップしました。" . PHP_EOL;
68    }
69}
70
71// 関数を実行します。
72demonstrateFilesystemIteratorIsReadable();
73
74?>

PHP 8のFilesystemIteratorクラスに属するisReadableメソッドは、現在処理中のファイルまたはディレクトリがPHPプロセスから読み込み可能かどうかを判定します。このメソッドは引数を必要とせず、読み込み可能であれば真偽値のtrueを、読み込み不可能であればfalseを戻り値として返します。

このサンプルコードは、システムの一時ディレクトリ内に、意図的に読み込み可能なファイルと、読み込み不可能なファイルを作成し、isReadableメソッドの挙動を確認するものです。具体的には、通常の読み込み権限（0644）を持つファイルに対してはisReadableがtrueを返し、一方で、すべてのユーザーが読み書き実行できないよう権限を0000に設定したファイルに対してはfalseを返すことを示しています。これにより、ファイルシステム上の権限設定がPHPのファイル読み込み操作にどのように影響するかを理解できます。特に「php is_readable false」の状況は、このようにファイル権限が適切でない場合に発生します。なお、この権限設定はLinux/Unix系のファイルシステムを想定しており、Windows環境では動作が異なる場合があります。コードの最後には、テストで作成した一時ファイルとディレクトリが適切にクリーンアップされます。