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

Copy
1<?php
2
3/**
4 * Pharアーカイブ内のファイルが読み取り可能かどうかをチェックするサンプルコードです。
5 *
6 * このスクリプトは以下の手順で動作します。
7 * 1. 一時的なPharアーカイブファイルを作成します。
8 * 2. そのPharアーカイブ内にダミーのテキストファイルを追加します。
9 * 3. 作成したPharアーカイブを開き、内部のファイル情報（PharFileInfoオブジェクト）を取得します。
10 * 4. PharFileInfo::isReadable() メソッドを呼び出し、ファイルが読み取り可能か確認します。
11 * 5. 確認結果とファイルの内容（読み取り可能な場合）を出力します。
12 * 6. 最後に、作成したPharアーカイブファイルをクリーンアップします。
13 */
14function checkPharFileReadability(): void
15{
16    // 一時的なPharアーカイブのパスと内部ファイル名を定義
17    $pharPath = __DIR__ . '/example_app.phar';
18    $internalFileName = 'info.txt';
19    $internalFileContent = 'Hello from inside the Phar archive! This file should be readable.';
20
21    try {
22        // 1. 新しいPharアーカイブを作成（既に存在する場合は上書き）
23        // Phar::mapPhar() を使用しないため、エイリアスは必須ではありませんが、一貫性のため設定
24        echo "1. Pharアーカイブを作成中: {$pharPath}\n";
25        $phar = new Phar($pharPath, 0, 'example_app.phar');
26
27        // ファイル書き込み中に他の操作ができないようにバッファリングを開始
28        $phar->startBuffering();
29
30        // 2. ダミーのテキストファイルをPharアーカイブに追加
31        $phar->addFromString($internalFileName, $internalFileContent);
32
33        // バッファリングを終了し、Pharアーカイブを保存して閉じます
34        $phar->stopBuffering();
35        unset($phar); // Pharオブジェクトを解放し、ファイルロックを解除
36
37        echo "   Pharアーカイブに '{$internalFileName}' を追加しました。\n";
38
39        // 3. 作成したPharアーカイブを開く
40        echo "\n3. Pharアーカイブを開いて内部ファイルを検証中...\n";
41        $pharReader = new Phar($pharPath);
42
43        // 4. Pharアーカイブ内のファイルをイテレートし、指定のファイル情報（PharFileInfo）を取得
44        $fileFound = false;
45        foreach ($pharReader as $fileInfo) {
46            // 現在のファイルのパスが目的の内部ファイル名と一致するか確認
47            if ($fileInfo->getFilename() === $internalFileName) {
48                $fileFound = true;
49                echo "   内部ファイル '{$fileInfo->getFilename()}' の情報を取得しました。\n";
50
51                // 5. PharFileInfo::isReadable() メソッドを呼び出し、読み取り可能かチェック
52                if ($fileInfo->isReadable()) {
53                    echo "   → このファイルはPharアーカイブ内で読み取り可能です。\n";
54                    // 読み取り可能なので、ファイルの内容を読み取って表示
55                    echo "   ファイル内容: " . $fileInfo->openFile()->fread($fileInfo->getSize()) . "\n";
56                } else {
57                    echo "   → このファイルはPharアーカイブ内で読み取り不可能です。\n";
58                }
59                break; // 目的のファイルが見つかったのでループを終了
60            }
61        }
62        unset($pharReader); // Pharオブジェクトを解放し、ファイルロックを解除
63
64        if (!$fileFound) {
65            echo "   エラー: 目的の内部ファイル '{$internalFileName}' がPharアーカイブ内で見つかりませんでした。\n";
66        }
67
68    } catch (PharException $e) {
69        // Phar関連のエラーをキャッチ
70        echo "\nエラーが発生しました (PharException): " . $e->getMessage() . "\n";
71    } catch (Exception $e) {
72        // その他の一般的なエラーをキャッチ
73        echo "\n予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
74    } finally {
75        // 6. 常にPharアーカイブファイルをクリーンアップ
76        if (file_exists($pharPath)) {
77            unlink($pharPath);
78            echo "\n6. 作成したPharアーカイブを削除しました: {$pharPath}\n";
79        }
80    }
81}
82
83// サンプルコードを実行
84checkPharFileReadability();

PHP 8のPharFileInfo::isReadable()メソッドは、PHPアプリケーションを単一のファイルにまとめるPharアーカイブの内部にある特定のファイルが、現在のPHPプロセスから読み取り可能かどうかを確認するために使用されます。このメソッドは引数を一切取らず、ファイルが読み取り可能な状態であればtrueを、そうでない場合はfalseをbool型で返します。

提供されたサンプルコードでは、まず一時的なPharアーカイブを新規作成し、その中にダミーのテキストファイルを格納しています。次に、作成したPharアーカイブを再度開いて内部ファイルを走査し、目的のファイルに対応するPharFileInfoオブジェクトを取得します。このPharFileInfoオブジェクトに対してisReadable()メソッドを呼び出すことで、そのファイルがPharアーカイブ内で安全に読み取れるかどうかが検証されます。サンプルでは、読み取り可能と判定された場合に実際にファイルの内容を読み取って出力しており、このメソッドがPharアーカイブ内のリソースへのアクセス可否を事前に確認するのに役立つことを示しています。これにより、アーカイブ内のファイル操作の安全性を高めることができます。

Copy
1<?php
2
3/**
4 * PharFileInfo::isReadable() メソッドの動作を示すサンプルコードです。
5 *
6 * この関数は、一時的なPharアーカイブを作成し、その中の存在するファイルと
7 * 存在しないファイルに対して isReadable() メソッドを適用します。
8 *
9 * isReadable() メソッドは、ファイルが存在しない場合に false を返します。
10 *
11 * 注意: このコードを実行するには、php.ini で 'phar.readonly = 0' を設定する必要があります。
12 *      (例: phar.readonly = Off)
13 */
14function demonstratePharFileInfoIsReadableExample(): void
15{
16    // 一時的なPharファイルの名前とパスを定義します。
17    $pharFileName = __DIR__ . '/temp_archive.phar';
18    $existingFileInPhar = 'existing_file.txt';
19    $nonExistentFileInPhar = 'non_existent_file.txt';
20
21    try {
22        // 既存のPharファイルを削除し、新しいPharアーカイブを作成します。
23        // これはテスト環境をクリーンに保つためです。
24        @unlink($pharFileName);
25
26        // 新しいPharアーカイブを書き込みモードで開きます。
27        // この操作には php.ini で phar.readonly = 0 が必要です。
28        $phar = new Phar($pharFileName);
29        $phar->startBuffering(); // 書き込み操作をバッファリングします。
30
31        // Pharアーカイブ内に既存のファイルを追加します。
32        $phar->addFromString($existingFileInPhar, "これはPharアーカイブ内の既存ファイルです。\n");
33
34        // Pharの実行時に使用されるスタブを設定します。
35        $phar->setStub($phar->createDefaultStub($existingFileInPhar));
36        $phar->stopBuffering(); // バッファリングを終了し、ファイルに書き込みます。
37
38        echo "Pharアーカイブ '{$pharFileName}' を正常に作成しました。\n\n";
39
40        // ----------------------------------------------------
41        // 1. アーカイブ内の既存ファイルに対する isReadable() のテスト
42        // ----------------------------------------------------
43        // Pharオブジェクトから既存ファイルへのPharFileInfoオブジェクトを取得します。
44        $existingFileInfo = $phar[$existingFileInPhar];
45
46        echo "--- 既存のファイル '{$existingFileInPhar}' の読み込み可能性 ---\n";
47        if ($existingFileInfo->isReadable()) {
48            echo "  -> このファイルは読み込み可能です。\n"; // 通常、ここが実行されます。
49        } else {
50            echo "  -> このファイルは読み込み不可能です。\n";
51        }
52        echo "\n";
53
54        // ----------------------------------------------------
55        // 2. キーワードに関連するシナリオ: アーカイブ内の存在しないファイルに対する isReadable() のテスト
56        // ----------------------------------------------------
57        // Pharオブジェクトから存在しないファイルへのPharFileInfoオブジェクトを取得します。
58        // この操作自体は例外を発生させませんが、ファイルは実際には存在しません。
59        $nonExistentFileInfo = $phar[$nonExistentFileInPhar];
60
61        echo "--- 存在しないファイル '{$nonExistentFileInPhar}' の読み込み可能性 ---\n";
62        // isReadable() メソッドは、ファイルが存在しない場合に false を返します。
63        if ($nonExistentFileInfo->isReadable() === false) {
64            echo "  -> このファイルは読み込み不可能です (ファイルが存在しません)。\n"; // ここが実行されることを期待します。
65        } else {
66            echo "  -> このファイルは読み込み可能です (これは予期せぬ結果です)。\n";
67        }
68        echo "\n";
69
70    } catch (PharException $e) {
71        // Phar操作中にエラーが発生した場合、メッセージを表示します。
72        echo "Phar操作中にエラーが発生しました: " . $e->getMessage() . "\n";
73        echo "php.ini で 'phar.readonly = 0' が設定されていることを確認してください。\n";
74    } finally {
75        // テストで使用したPharファイルをクリーンアップします。
76        if (file_exists($pharFileName)) {
77            @unlink($pharFileName);
78            echo "Pharアーカイブ '{$pharFileName}' を削除しました。\n";
79        }
80    }
81}
82
83// サンプル関数を実行します。
84demonstratePharFileInfoIsReadableExample();

PharFileInfo::isReadable()メソッドは、PHPのPharアーカイブ（複数のファイルをまとめた単一の実行可能ファイル）内の特定のファイルが、プログラムから読み込み可能かどうかを判定するために使用されます。このメソッドは引数を必要とせず、ファイルが読み込み可能であれば真偽値trueを、読み込み不可能であればfalseを戻り値として返します。

サンプルコードでは、まず一時的なPharアーカイブを作成し、その中に存在するファイルと、存在しないファイルを想定してテストを行っています。アーカイブ内に実際に存在するファイルに対してisReadable()を実行すると、通常はtrueが返されます。

特に重要な点として、このメソッドは指定されたファイルがPharアーカイブ内に存在しない場合、明確にfalseを返します。これにより、開発者はアーカイブ内のファイルの有無と読み込み可能性を同時に確認できます。Pharアーカイブの作成には、php.iniでphar.readonly = 0を設定する必要がある点にご注意ください。このメソッドは、Pharアーカイブを扱うアプリケーションで、ファイルアクセスに関する検証を行う際に役立ちます。