【PHP8.x】T_INC定数の使い方

Copy
1<?php
2
3/**
4 * 指定されたPHPファイル内にincludeまたはrequire文が存在するかどうかをチェックします。
5 * リファレンス情報の「T_INC」はPHPの内部トークン定数で、通常はT_INCLUDEとして知られ、
6 * PHPのパーサーがincludeキーワードを識別するために使用されます。
7 * この関数では、T_INCLUDEを含む関連するすべてのインクルード系キーワード（T_REQUIREなど）を検出します。
8 *
9 * @param string $filepath チェックするPHPファイルのパス。
10 * @return bool includeまたはrequire文が見つかった場合はtrue、それ以外はfalse。
11 */
12function checkPhpFileForIncludeStatements(string $filepath): bool
13{
14    // ファイルが存在しない場合はエラーをログに記録して処理を終了
15    if (!file_exists($filepath)) {
16        error_log("Error: Target file '{$filepath}' not found for token analysis.");
17        return false;
18    }
19
20    // ファイルの内容を文字列として取得
21    $content = file_get_contents($filepath);
22    if ($content === false) {
23        error_log("Error: Could not read file '{$filepath}' for token analysis.");
24        return false;
25    }
26
27    // PHPコードをトークンに分割
28    $tokens = token_get_all($content);
29
30    // トークンを走査し、インクルード/リクワイヤー系のキーワードを探す
31    foreach ($tokens as $token) {
32        // トークンは通常配列形式（[トークンID, 文字列, 行番号]）または単一文字（演算子など）
33        if (is_array($token)) {
34            // T_INCLUDE, T_REQUIRE, T_INCLUDE_ONCE, T_REQUIRE_ONCE は、
35            // PHPコード内のインクルード文を表すトークン定数です。
36            // リファレンス情報の T_INC は、これらのトークン定数を指すものと解釈し、
37            // PHP 8で実際に利用可能な定数を使用します。
38            if (in_array($token[0], [T_INCLUDE, T_REQUIRE, T_INCLUDE_ONCE, T_REQUIRE_ONCE], true)) {
39                return true; // インクルード文が見つかった
40            }
41        }
42    }
43
44    return false; // インクルード文が見つからなかった
45}
46
47/**
48 * PHPのinclude文の基本的な動作と、「php include doesn't work」
49 * という問題（特にファイルが見つからないケース）への対処法をデモンストレーションします。
50 */
51function demonstrateIncludeErrorHandling(): void
52{
53    echo "--- PHP 'include' 動作デモンストレーション ---" . PHP_EOL;
54
55    // 実際にインクルードされるダミーファイルを作成
56    $includedFile = 'example_included_content.php';
57    file_put_contents($includedFile, "<?php echo 'こんにちは、これは {$includedFile} からのメッセージです！' . PHP_EOL; ?>");
58
59    // 意図的に存在しないインクルードファイルのパス
60    $nonExistentFile = 'non_existent_content.php';
61
62    // 1. 成功するインクルードの例
63    echo PHP_EOL . "1. 存在するファイルをインクルードする例:" . PHP_EOL;
64    // includeする前にfile_exists()でファイルの存在を確認することが重要です。
65    if (file_exists($includedFile)) {
66        echo "ファイル '{$includedFile}' は存在します。インクルードを試みます..." . PHP_EOL;
67        include $includedFile; // ファイルをインクルードして、その中のコードを実行します
68    } else {
69        echo "エラー: ファイル '{$includedFile}' が見つかりません。パスを確認してください。" . PHP_EOL;
70    }
71
72    // 2. 失敗するインクルードの例（ファイルが見つからない場合）
73    echo PHP_EOL . "2. 存在しないファイルをインクルードしようとする例 ('php include doesn\'t work' の一般的な原因):" . PHP_EOL;
74    // file_exists() で事前にチェックすることで、PHPが致命的なエラーを発生させるのを防ぎます。
75    echo "ファイル '{$nonExistentFile}' の存在を確認中..." . PHP_EOL;
76    if (file_exists($nonExistentFile)) {
77        // このブロックは、$nonExistentFile が存在しないため通常実行されません
78        echo "ファイル '{$nonExistentFile}' は存在します。インクルードを試みます..." . PHP_EOL;
79        include $nonExistentFile;
80    } else {
81        echo "エラー: ファイル '{$nonExistentFile}' が見つかりません。" . PHP_EOL;
82        echo "ファイルが存在しない場合、'include' は Warning を出力しスクリプトの実行を続けます。" . PHP_EOL;
83        echo "しかし 'require' の場合は、致命的なエラー (Fatal Error) となりスクリプトが停止します。" . PHP_EOL;
84        echo "安全のため、インクルードする前に file_exists() でファイルの存在を確認することを強く推奨します。" . PHP_EOL;
85    }
86
87    // 3. (参考) checkPhpFileForIncludeStatements 関数を使ったトークン解析の例
88    echo PHP_EOL . "--- (参考) PHPファイル内の include/require 文の存在チェック ---" . PHP_EOL;
89    
90    // 現在のスクリプト自身をチェック
91    // このスクリプト自体には、直接 include/require が含まれていないため、false となるでしょう
92    if (checkPhpFileForIncludeStatements(__FILE__)) {
93        echo "このスクリプト (" . basename(__FILE__) . ") には include/require 文が含まれています。" . PHP_EOL;
94    } else {
95        echo "このスクリプト (" . basename(__FILE__) . ") には include/require 文は含まれていません。" . PHP_EOL;
96    }
97
98    // 作成したダミーファイルをチェック
99    // このダミーファイル自体には include 文はないはずなので、false となるでしょう
100    if (checkPhpFileForIncludeStatements($includedFile)) {
101        echo "ファイル '{$includedFile}' には include/require 文が含まれています。" . PHP_EOL;
102    } else {
103        echo "ファイル '{$includedFile}' には include/require 文は含まれていません。" . PHP_EOL;
104    }
105
106    // 後処理: 作成したダミーファイルを削除して環境をクリーンアップ
107    if (file_exists($includedFile)) {
108        unlink($includedFile);
109        echo PHP_EOL . "後処理: 作成したダミーファイル '{$includedFile}' を削除しました。" . PHP_EOL;
110    }
111}
112
113// デモンストレーション関数の実行
114demonstrateIncludeErrorHandling();
115
116?>

このサンプルコードは、PHPのinclude文の基本的な使い方と、「php include doesn't work」といった、ファイルが見つからない場合の一般的な問題とその対処法を解説します。

checkPhpFileForIncludeStatements関数は、与えられたPHPファイルの中にincludeやrequireといった、他のファイルを読み込む命令（インクルード文）が含まれているかを検査します。PHPのコードを内部的に分析するtoken_get_all関数を使い、T_INCLUDEやT_REQUIREといったトークン定数（リファレンス情報のT_INCが概念的に指す、インクルード関連のキーワード）を検出します。この関数は、引数$filepathで指定されたファイルパスのファイルをチェックし、インクルード文があればtrue、なければfalseを返します。

demonstrateIncludeErrorHandling関数は、include文の実際の動作を実演します。存在するファイルを正常にインクルードする成功例と、存在しないファイルをインクルードしようとしてエラーとなる失敗例を通じて、include文が機能しない主な原因（ファイルパスの誤りやファイル不在）を分かりやすく示しています。この関数では、includeやrequireを実行する前にfile_exists()関数でファイルの存在を事前に確認することの重要性を強調しており、これにより予期せぬエラーを防ぐことができます。この関数はデモンストレーションを行うため、戻り値はありません。