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

Copy
1<?php
2
3// SplFileInfo::isReadable メソッドの使用例
4// このメソッドは、指定されたファイルがスクリプトから読み込み可能であるかどうかをチェックします。
5
6/**
7 * 指定されたファイルパスの読み込み可能性をチェックし、結果を表示します。
8 *
9 * @param string $filePath チェックするファイルのパス
10 * @return void
11 */
12function checkFileReadability(string $filePath): void
13{
14    // SplFileInfo オブジェクトを作成します。
15    // このオブジェクトは、ファイルシステム上のファイルやディレクトリの情報にアクセスするためのものです。
16    $fileInfo = new SplFileInfo($filePath);
17
18    echo "対象ファイル: '{$filePath}'\n";
19
20    // isReadable() メソッドを呼び出し、ファイルが読み込み可能かを確認します。
21    // このメソッドに引数はありません。戻り値は boolean (true または false) です。
22    if ($fileInfo->isReadable()) {
23        echo "-> このファイルは読み込み可能です。\n";
24    } else {
25        echo "-> このファイルは読み込み可能ではありません。\n";
26        // 読み込み可能ではない主な理由として、以下のいずれかが考えられます。
27        // 1. 指定されたファイルが存在しない。
28        // 2. スクリプトを実行しているPHPプロセスに、ファイルの読み取り権限がない。
29    }
30    echo "\n"; // 各チェックの表示を区切るための改行
31}
32
33// --- サンプル実行 ---
34
35// 1. 存在しないファイルをチェックする例
36//    このファイルは通常存在しないため、"読み込み可能ではありません" と表示されるはずです。
37checkFileReadability(__DIR__ . '/non_existent_file.txt');
38
39// 2. 読み込み可能なファイルをチェックする例
40//    このスクリプトを実行するディレクトリに 'test_readable.txt' というファイルを作成し、
41//    内容を書き込んでから実行すると、"読み込み可能です" と表示される動作を確認できます。
42//    例 (Linux/macOS): echo "Hello PHP" > test_readable.txt && chmod 644 test_readable.txt
43//    例 (Windows): type NUL > test_readable.txt (その後、メモ帳などで内容を追加)
44checkFileReadability(__DIR__ . '/test_readable.txt');
45
46// 3. (オプション) 読み込み不可なファイルをチェックする例
47//    'test_unreadable.txt' を作成し、スクリプト実行ユーザーに読み取り権限がないように設定すると、
48//    "読み込み可能ではありません" と表示されます。
49//    例 (Linux/macOS): echo "Hidden" > test_unreadable.txt && chmod 000 test_unreadable.txt
50// checkFileReadability(__DIR__ . '/test_unreadable.txt');
51
52?>

PHPのSplFileInfo::isReadableメソッドは、指定されたファイルが現在のPHPスクリプトから読み込み可能であるかを判定するために使用されます。このメソッドはSplFileInfoクラスに属しており、ファイルシステム上のファイルやディレクトリに関する情報にアクセスするためのオブジェクトから呼び出されます。

まず、対象となるファイルのパスを指定してSplFileInfoオブジェクトを生成します。その後、そのオブジェクトからisReadable()メソッドを呼び出すことで、ファイルの読み込み可能性をチェックします。このメソッドは引数を一切取りません。戻り値は真偽値（trueまたはfalse）であり、ファイルが読み込み可能であればtrueを、そうでなければfalseを返します。

ファイルが読み込み可能ではない主なケースとしては、指定されたパスにファイル自体が存在しない場合や、ファイルは存在するものの、スクリプトを実行しているPHPプロセスにそのファイルを読み取る権限がない場合が考えられます。サンプルコードでは、存在しないファイル、読み込み可能なファイル、そして（オプションとして）読み込み権限がないファイルのそれぞれのケースでisReadable()メソッドの挙動を確認し、結果を表示しています。これにより、ファイル操作を行うシステム開発において、安全にファイルを処理するための事前のチェック方法を学ぶことができます。

Copy
1<?php
2
3// このサンプルコードは、PHPのSplFileInfoクラスのisReadableメソッドの基本的な使い方を示します。
4// isReadableメソッドは、特定のファイルパスが読み取り可能であるかをチェックし、
5// 読み込み可能であればtrue、そうでなければfalseを返します。
6// 特に、ファイルが存在しない場合にfalseを返すケースに焦点を当てています。
7
8/**
9 * 指定されたファイルパスが読み取り可能であるかをチェックし、結果を出力します。
10 *
11 * @param string $filePath チェックするファイルパス
12 */
13function checkFileReadabilityStatus(string $filePath): void
14{
15    echo "チェック対象のファイルパス: " . $filePath . PHP_EOL;
16
17    // SplFileInfoオブジェクトを作成します。
18    // この時点では、ファイルが実際に存在するかどうかはチェックされません。
19    $fileInfo = new SplFileInfo($filePath);
20
21    // isReadable()メソッドを呼び出して、ファイルが読み取り可能かを判断します。
22    // ファイルが存在しない場合や、システムによって読み取り権限がないと判断された場合にfalseを返します。
23    if ($fileInfo->isReadable()) {
24        echo "結果: このファイルは読み取り可能です。" . PHP_EOL;
25    } else {
26        // キーワード「php is_readable false」に対応する主要な出力です。
27        echo "結果: このファイルは読み取りできません（ファイルが存在しない、または権限がない可能性があります）。" . PHP_EOL;
28    }
29    echo PHP_EOL; // 結果を見やすくするための改行
30}
31
32// --------------------------------------------------------------------------
33// サンプルコード実行部分
34// --------------------------------------------------------------------------
35
36// 1. 存在しないファイルパスを生成します。
37// sys_get_temp_dir() で一時ディレクトリを取得し、uniqid() でユニークな名前を生成します。
38// これにより、isReadableメソッドが確実にfalseを返す典型的なケースを示すことができます。
39$nonExistentFilePath = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'non_existent_php_file_' . uniqid() . '.txt';
40
41// 生成した存在しないファイルパスに対してisReadableメソッドを試します。
42checkFileReadabilityStatus($nonExistentFilePath);
43
44?>

PHPのSplFileInfoクラスが提供するisReadableメソッドは、指定されたファイルパスが現在のスクリプトから読み取り可能であるかをチェックするために用いられます。このメソッドは引数を取らず、ファイルの読み取りが可能であればtrueを、不可能であればfalseをブール値として返します。

特に、このメソッドはファイルが存在しない場合や、存在しても現在のユーザーまたはPHPスクリプトに読み取り権限がない場合にfalseを返します。サンプルコードでは、sys_get_temp_dir()関数とuniqid()関数を組み合わせて、意図的にファイルシステム上に存在しない一時ファイルパスを生成しています。これにより、isReadableメソッドがfalseを返す典型的な状況を明確に示しています。

SplFileInfoオブジェクトは、ファイルパスを基に作成されますが、その時点ではファイルの実在確認は行われません。実際のファイルシステムへのアクセス権限や存在確認は、isReadableのようなメソッドが実行された際に行われます。この機能は、ファイル内容を読み込む処理を行う前に、エラーを防ぐための事前チェックとして活用でき、堅牢なシステム開発において重要な役割を果たします。