【PHP8.x】get_required_files関数の使い方

<?php

declare(strict_types=1);

/**
 * get_required_files() 関数の動作を実演します。
 *
 * この関数は、`require`, `include`, `require_once`, `include_once` によって
 * スクリプト実行中に読み込まれたすべてのファイルのパスを配列で返します。
 *
 * このサンプルでは、実行中に動的にファイルを作成して `require` し、
 * 読み込まれたファイルのリストがどのように変化するかを確認します。
 */
function demonstrateGetRequiredFiles(): void
{
    // --- 準備: 読み込むための一時ファイルを作成 ---
    $tempFileName = 'temporary_included_file.php';
    $fileContent = '<?php // このファイルはサンプルコードによって動的に生成・読み込みされました。';

    if (file_put_contents($tempFileName, $fileContent) === false) {
        echo "エラー: 一時ファイルの作成に失敗しました。\n";
        return;
    }

    echo "--- 1. require を実行する前の状態 ---\n";
    // この時点では、主に実行中のスクリプトファイル自身がリストに含まれます。
    print_r(get_required_files());
    echo "\n";


    // --- 実行: 作成した一時ファイルを読み込む ---
    require $tempFileName;


    echo "--- 2. '{$tempFileName}' を require した後の状態 ---\n";
    // get_required_files() を再度呼び出し、読み込まれたファイルのリストを取得します。
    // 新しく require されたファイルがリストに追加されていることがわかります。
    $requiredFiles = get_required_files();

    echo "現在、以下のファイルが読み込まれています:\n";
    foreach ($requiredFiles as $index => $filePath) {
        // realpath() で正規化された絶対パスを表示します。
        $realPath = realpath($filePath);
        echo ($index + 1) . ": " . $realPath . "\n";
    }

    // --- 後片付け: 作成した一時ファイルを削除 ---
    unlink($tempFileName);
}

// サンプル関数を実行します。
demonstrateGetRequiredFiles();

get_required_files()関数は、スクリプトの実行中に読み込まれた全てのファイルのパスを配列で取得するPHPの組み込み関数です。require、include、require_once、include_onceといった命令文によって読み込まれたファイルが対象となります。この関数は引数を取らず、戻り値として各ファイルの絶対パスが格納された配列を返します。

このサンプルコードでは、get_required_files()の動作を段階的に示しています。まず、require文を実行する前に一度この関数を呼び出し、その時点での読み込み済みファイルリストを表示します。次に、プログラム内で動的に新しいPHPファイルを作成し、それをrequireで読み込みます。その後、もう一度get_required_files()を呼び出すと、先ほどrequireしたファイルのパスが配列に追加されていることが確認できます。

このように、この関数を使うことで、プログラムが実行されている最中にどのファイルが読み込まれているかを動的に把握することが可能です。これは、依存関係の確認やデバッグの際に役立ちます。