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

Copy
1<?php
2
3// T_FINALLY定数の使用例を示す関数
4// T_FINALLYはPHPコードをトークンに分解した際に、'finally'キーワードを表す定数です。
5function demonstrateTFinallyToken(): void
6{
7    // 解析対象のPHPコードスニペットを文字列として定義します。
8    // 'finally'キーワードを含むtry...catch...finallyブロックを含めます。
9    $codeSnippet = <<<'EOD'
10<?php
11try {
12    // 例外が発生する可能性のある処理
13    echo "tryブロックが実行されました。\n";
14    // throw new Exception("意図的に例外を発生");
15} catch (Exception $e) {
16    // 例外がキャッチされた場合の処理
17    echo "catchブロックが実行されました: " . $e->getMessage() . "\n";
18} finally {
19    // finallyブロックは、例外の有無にかかわらず、try/catchブロックの後に常に実行されます。
20    echo "finallyブロックが実行されました。\n";
21}
22EOD;
23
24    echo "--- PHPコードスニペットの実行結果 ---\n";
25    // この行はスニペットのコードを実際に実行しているわけではありませんが、
26    // 動作を理解してもらうため、コードスニペットを echo で表示します。
27    // 実際にPHPがこのスニペットを評価する場合の出力イメージ
28    eval(ltrim($codeSnippet, '<?php'));
29    echo "------------------------------------\n\n";
30
31    echo "--- T_FINALLYトークンの検出 ---\n";
32
33    // token_get_all() 関数を使ってPHPコードをトークン（構文要素）の配列に分解します。
34    // PHPパーサがコードを理解する際に行う最初のステップと似ています。
35    $tokens = token_get_all($codeSnippet);
36
37    $found = false;
38    foreach ($tokens as $token) {
39        // 各トークンは通常、配列形式（[タイプ, 値, 行番号]）または単一の文字列（単一文字の演算子など）です。
40        if (is_array($token)) {
41            // トークンのタイプがT_FINALLYであるかを確認します。
42            // T_FINALLYは、PHPのトークン定数の一つで、'finally'キーワードに対応します。
43            if ($token[0] === T_FINALLY) {
44                echo "T_FINALLYトークンが見つかりました！\n";
45                echo "  トークン名: " . token_name($token[0]) . " (定数値: " . $token[0] . ")\n";
46                echo "  テキスト値: '" . $token[1] . "'\n";
47                echo "  行番号: " . $token[2] . "\n";
48                $found = true;
49                break; // T_FINALLYは一度見つければ十分なのでループを抜けます
50            }
51        }
52    }
53
54    if (!$found) {
55        echo "T_FINALLYトークンは見つかりませんでした。\n";
56    }
57    echo "-------------------------------\n";
58}
59
60// 関数を実行してT_FINALLYトークンの検出をデモンストレーションします。
61demonstrateTFinallyToken();

PHPのT_FINALLY定数は、PHP 8から利用できる拡張機能の一部で、PHPのソースコードを解析する際に用いられる特別な識別子です。この定数自体は引数を持ちませんが、PHPスクリプトをトークンと呼ばれる構文要素に分解する際、特定のキーワード「finally」を整数値（int）で表す役割を担います。

具体的には、token_get_all()関数などを用いてPHPコードをトークンの配列に変換する際に、try...catch...finallyブロックにおける「finally」というキーワードが検出されると、そのトークンのタイプとしてT_FINALLYという整数値が割り当てられます。これにより、プログラムはPHPコードの構造を内部的に理解し、どの部分が「finally」キーワードであるかを識別できるようになります。

サンプルコードでは、PHPコードスニペットをtoken_get_all()関数で解析し、生成されたトークンの配列からT_FINALLY定数と一致するトークンを探しています。これにより、コード内の「finally」キーワードがどのようにプログラムによって認識され、その種類や値、行番号などの情報が取得できるかを示しています。T_FINALLYは、PHPパーサーがコードを構文解析する過程で重要な役割を果たす定数の一つです。

Copy
1<?php
2
3/**
4 * 親クラスを定義します。
5 * finalキーワードがないメソッドは子クラスでオーバーライド可能です。
6 */
7class BaseClass
8{
9    /**
10     * オーバーライド可能なメソッドの例。
11     * 子クラスで異なる振る舞いをさせることができます。
12     */
13    public function showStatus(): void
14    {
15        echo "BaseClass: システムは正常稼働中です。\n";
16    }
17
18    /**
19     * finalキーワードで定義されたメソッドは、子クラスでオーバーライドできません。
20     * このメソッドの振る舞いが常に一定であることを保証したい場合に利用します。
21     * 例えば、基盤システムやライブラリの重要なバージョン情報などに適用されます。
22     */
23    final public function getSystemVersion(): string
24    {
25        return "システムバージョン: 1.0.0 (基盤モジュール)\n";
26    }
27
28    /**
29     * 親クラスの情報表示メソッド。
30     * finalメソッドもここから呼び出せます。
31     */
32    public function displayBaseInfo(): void
33    {
34        $this->showStatus();
35        echo $this->getSystemVersion();
36    }
37}
38
39/**
40 * BaseClassを継承する子クラスを定義します。
41 */
42class ChildClass extends BaseClass
43{
44    /**
45     * 親クラスのshowStatusメソッドはfinalではないため、オーバーライド可能です。
46     * 子クラス固有の情報を追加して表示します。
47     */
48    public function showStatus(): void
49    {
50        echo "ChildClass: 拡張機能も正常稼働中です。\n";
51    }
52
53    /**
54     * 親クラスのgetSystemVersionメソッドはfinalであるため、オーバーライドしようとするとPHP Fatal Errorになります。
55     * 以下のコメントアウトされたコードブロックを有効にするとエラーが発生します。
56     *
57     * public function getSystemVersion(): string
58     * {
59     *     return "システムバージョン: 2.0.0 (拡張モジュール)\n";
60     * }
61     */
62
63    /**
64     * 子クラスの情報表示メソッド。
65     * オーバーライドされたshowStatusと、親のfinalメソッドgetSystemVersionを呼び出します。
66     */
67    public function displayChildInfo(): void
68    {
69        $this->showStatus(); // 子クラスでオーバーライドされたメソッドが呼ばれる
70        echo "--- 親クラスのfinalメソッドを呼び出し ---\n";
71        echo $this->getSystemVersion(); // 親クラスのfinalメソッドが呼ばれる
72    }
73}
74
75// --- コードの実行 ---
76
77echo "--- 親クラス (BaseClass) の実行例 ---\n";
78$baseInstance = new BaseClass();
79$baseInstance->displayBaseInfo();
80echo "\n";
81
82echo "--- 子クラス (ChildClass) の実行例 ---\n";
83$childInstance = new ChildClass();
84$childInstance->displayChildInfo();
85echo "\n";
86
87echo "--- finalメソッドに関する補足 ---\n";
88echo "BaseClassの'getSystemVersion'メソッドは'final'として宣言されています。\n";
89echo "これは、ChildClassがそのメソッドをオーバーライドできないことを意味します。\n";
90echo "もしChildClass内で'getSystemVersion'メソッドのコメントを外して定義しようとすると、\n";
91echo "PHPは致命的なエラー ('Fatal Error: Cannot override final method BaseClass::getSystemVersion()') を発生させます。\n";
92echo "この仕組みは、特定のメソッドの動作が一貫していることを保証するのに役立ちます。\n";
93

PHP 8のfinalキーワードは、クラスのメソッドに適用することで、子クラスがそのメソッドをオーバーライド（上書き）することを禁止します。 サンプルコードでは、BaseClassのgetSystemVersionメソッドにfinalが適用されており、ChildClassでこのメソッドを再定義しようとすると、「Cannot override final method」という致命的なエラーとなります。 この機能は、基盤システムなど常に同じ動作をさせたい重要なメソッドの変更を防ぎ、システムの安定性と一貫性を保証するのに役立ちます。 一方、finalキーワードがないshowStatusメソッドは、ChildClassで自由にオーバーライドされ、子クラス独自の振る舞いを定義できます。 finalメソッドも通常のメソッドと同様に引数を取ったり値を返したりでき、getSystemVersionメソッドは引数なしで文字列（string）を返しています。 このようにfinalキーワードは、システムの安定した部分と拡張可能な部分を明確に区別する設計に活用できます。