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

Copy
1<?php
2
3/**
4 * 指定されたPHPコード文字列を解析し、トークン情報を表示します。
5 * 特に、PHP 8で導入されたT_CALLABLEトークンと、変数を示すT_VARIABLEトークンの検出に焦点を当てます。
6 *
7 * T_で始まる定数（例: T_CALLABLE, T_VARIABLE）は、PHPの内部的なトークン定数であり、
8 * ソースコードを解析する際に各要素（キーワード、変数名など）の種類を識別するために使用されます。
9 *
10 * @param string $phpCode 解析対象のPHPコード文字列。
11 */
12function analyzePhpTokens(string $phpCode): void
13{
14    echo "--- 解析対象のPHPコード ---\n";
15    echo $phpCode . "\n";
16    echo "--------------------------\n\n";
17
18    // token_get_all() 関数は、PHPソースコードをトークンに分割します。
19    // 各トークンは配列（[トークンID, トークン値, 行番号]）または単一文字（例: '{', ';')として返されます。
20    $tokens = token_get_all($phpCode);
21
22    echo "--- 検出されたT_CALLABLEとT_VARIABLEトークン ---\n";
23    foreach ($tokens as $token) {
24        if (is_array($token)) {
25            $tokenId = $token[0]; // トークンの数値ID
26            $tokenName = token_name($tokenId); // トークンIDを人間が読める名前に変換
27            $tokenValue = $token[1]; // トークンの実際の文字列値
28            $lineNumber = $token[2]; // トークンが出現する行番号
29
30            // T_CALLABLEはPHP 8から導入されたトークンで、`callable`型ヒントを示します。
31            // T_VARIABLEはPHPコード内の変数名を示します。
32            if ($tokenId === T_CALLABLE) {
33                echo "[T_CALLABLE] (Name: {$tokenName}) Value: '{$tokenValue}' at Line {$lineNumber}\n";
34            } elseif ($tokenId === T_VARIABLE) {
35                echo "[T_VARIABLE] (Name: {$tokenName}) Value: '{$tokenValue}' at Line {$lineNumber}\n";
36            }
37        }
38    }
39    echo "--------------------------------------------------\n";
40}
41
42// 解析するPHPコードの例
43// このコードには 'callable' 型ヒントと、いくつかの変数 ($callback, $name, $message) が含まれています。
44$sampleCode = <<<PHP
45<?php
46
47function processData(callable \$callback, string \$name): void
48{
49    \$message = \$callback(\$name);
50    echo \$message . "\\n";
51}
52
53processData(function (string \$n) {
54    return "Hello, " . \$n . "!";
55}, "Alice");
56
57PHP;
58
59// 関数を実行してトークンを解析
60analyzePhpTokens($sampleCode);
61
62?>

このサンプルコードは、PHPのソースコードがどのように内部的に「トークン」と呼ばれる小さな要素に分解されるかを学ぶためのものです。特に、PHP 8で導入されたcallable型ヒントを示すT_CALLABLEトークンと、変数名を示すT_VARIABLEトークンの検出に焦点を当てています。

analyzePhpTokens関数は、引数として解析したいPHPコード文字列を受け取り、そのコードを解析して検出結果を表示します。この関数は情報表示が主な役割であり、特定の値を呼び出し元に返す戻り値はありません。関数内部では、token_get_all()関数を使用してPHPコードをトークンの配列に分割しています。

T_CALLABLEは、callableという型ヒント（関数やメソッドを引数として受け取ることを示す型）がコード内に出現した際に識別されるトークン定数です。T_VARIABLEは、PHPコード内で使用されている変数名（例えば$callbackや$nameなど）を識別するために用いられるトークン定数です。

コードは、分割されたトークンを一つずつ確認し、T_CALLABLEまたはT_VARIABLEに一致するものがあれば、その種類、実際の値、そしてコード中の出現行数を表示します。token_name()関数は、内部的なトークンIDを人間が理解しやすい文字列名に変換するために使われています。これにより、PHPがコードの各要素をどのように識別しているかを具体的に理解することができます。

Copy
1<?php
2
3/**
4 * PHPの「callable」型と配列の利用、および「T_CALLABLE」トークンを実演します。
5 * システムエンジニアを目指す初心者向けに、呼び出し可能な型(callable)の概念と、
6 * PHP内部で'callable'キーワードを識別するT_CALLABLEトークンの関連性を示します。
7 */
8function demonstrateCallableAndTokenUsage(): void
9{
10    echo "--- PHPの「callable」型と配列での利用 ---\n";
11
12    // 1. クロージャ（無名関数）は callable です
13    $sayHello = function (string $name) {
14        return "こんにちは、" . $name . "さん！";
15    };
16
17    // 2. クラスのスタティックメソッドも callable になり得ます
18    class SimpleUtility
19    {
20        public static function multiply(int $a, int $b): int
21        {
22            return $a * $b;
23        }
24    }
25
26    // さまざまな callable を含む配列を定義します
27    $callableFunctions = [
28        $sayHello,                           // クロージャ
29        'strlen',                            // 組み込み関数
30        [SimpleUtility::class, 'multiply'],  // クラスのスタティックメソッド
31    ];
32
33    echo "callable要素を含む配列の確認:\n";
34    foreach ($callableFunctions as $index => $callable) {
35        // is_callable() は、変数が呼び出し可能であるかをチェックする関数です
36        if (is_callable($callable)) {
37            echo "  配列の要素 {$index} は callable です。\n";
38        } else {
39            echo "  配列の要素 {$index} は callable ではありません。\n";
40        }
41    }
42
43    echo "\ncallable要素の実行例:\n";
44    echo "  クロージャの実行: " . $callableFunctions[0]('太郎') . "\n";
45    echo "  組み込み関数の実行 (strlen): " . $callableFunctions[1]('PHP') . "\n";
46    echo "  スタティックメソッドの実行 (multiply): " . call_user_func($callableFunctions[2], 5, 4) . "\n";
47
48
49    echo "\n--- T_CALLABLEトークンの確認 ---\n";
50
51    // T_CALLABLE定数の値を出力します。これはPHP内部で使われるトークンIDです。
52    echo "T_CALLABLE定数の値: " . T_CALLABLE . "\n";
53    // T_CALLABLE定数に対応する名前を取得します。
54    echo "T_CALLABLE定数名: " . token_name(T_CALLABLE) . "\n";
55
56    // `callable` 型ヒントが使われているPHPコードを文字列として定義します
57    $codeSnippet = <<<'EOD'
58<?php
59function processCallback(callable $callback): void {
60    $callback('データ');
61}
62EOD;
63
64    // token_get_all() を使って、PHPコードをトークン配列に分解します。
65    // T_CALLABLEは、ソースコード中の'callable'キーワードに対応するトークンです。
66    $tokens = token_get_all($codeSnippet);
67
68    echo "\nコードスニペット中の 'callable' キーワード (T_CALLABLEトークン) を検出:\n";
69    foreach ($tokens as $token) {
70        if (is_array($token) && $token[0] === T_CALLABLE) {
71            echo "  T_CALLABLEトークンを検出: '{$token[1]}' (行: {$token[2]})\n";
72        }
73    }
74}
75
76// サンプルコードを実行します
77demonstrateCallableAndTokenUsage();

PHPのT_CALLABLE定数とcallable型について、呼び出し可能な要素の扱い方を説明します。PHPにおけるcallable型は、関数やメソッド、無名関数（クロージャ）など、実行可能なコードブロックを指します。サンプルコードでは、これらの様々なcallable要素を配列に格納し、is_callable()関数でその要素が呼び出し可能かを確認しています。is_callable()は、指定された変数が呼び出し可能であればtrueを、そうでなければfalseを返します。配列内のcallableは、直接呼び出したり、引数として渡す関数を実行するcall_user_func()のような関数を使って実行したりできます。これにより、柔軟なコールバック処理を実現します。

次に、T_CALLABLE定数についてです。これはPHPが内部でソースコードを解析する際に、callableというキーワードを識別するために用いる「トークンID」です。token_name()関数を使うと、このトークンIDが具体的に何のキーワードに対応しているか文字列として確認できます。また、token_get_all()関数にPHPコード文字列を渡すと、コードが個々のトークンに分解され、その中からT_CALLABLEトークン（つまりcallableキーワード）を検出できる様子を示しています。token_get_all()はトークンの配列を返します。この定数は、PHPのパーサー（構文解析器）がどのようにコードを理解しているかを示す一例であり、開発者が直接使用する場面は稀ですが、PHPの内部動作を理解する上で役立ちます。