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

Copy
1<?php
2
3/**
4 * 指定されたディレクトリ内のPHPファイルをスキャンし、
5 * PHPの `list()` 構文（または配列デストラクチャリング `[$a, $b] = ...;`）が
6 * 使用されているファイル名とその行番号をリストアップします。
7 *
8 * @param string $directoryPath スキャンするディレクトリのパス
9 * @return array<string, array<int>> 'list()' 構文が見つかったファイル名とその行番号のマップ
10 */
11function findListConstructsInPhpFiles(string $directoryPath): array
12{
13    $foundListConstructs = [];
14
15    // ディレクトリが存在し、読み取り可能かチェック
16    if (!is_dir($directoryPath) || !is_readable($directoryPath)) {
17        // エラーメッセージは初心者向けにコンソールに出力
18        echo "Error: Directory does not exist or is not readable: " . $directoryPath . PHP_EOL;
19        return [];
20    }
21
22    // ディレクトリ内のすべてのファイルとディレクトリを取得
23    // glob() を使用して *.php ファイルのみを効率的に取得することも可能ですが、
24    // scandir() と手動チェックでより基本的なファイル操作を示します。
25    $files = scandir($directoryPath);
26
27    foreach ($files as $file) {
28        // 現在のディレクトリと親ディレクトリはスキップ
29        if ($file === '.' || $file === '..') {
30            continue;
31        }
32
33        $filePath = $directoryPath . DIRECTORY_SEPARATOR . $file;
34
35        // PHPファイルであるか、かつ通常のファイルであるかチェック
36        // pathinfo() で拡張子を取得し、小文字にして比較します。
37        if (is_file($filePath) && strtolower(pathinfo($filePath, PATHINFO_EXTENSION)) === 'php') {
38            $content = file_get_contents($filePath);
39            if ($content === false) {
40                // ファイル読み込みエラーが発生した場合、次のファイルへ
41                continue;
42            }
43
44            // PHPコードをPHPの内部トークンに分割
45            // T_LIST はPHPのトークン定数で、`list()` 構文を表します。
46            $tokens = token_get_all($content);
47            $linesFoundInFile = [];
48
49            foreach ($tokens as $token) {
50                // トークンは通常、[トークンID, 文字列, 行番号] の配列形式です。
51                // T_LIST はそのトークンIDの一つです。
52                if (is_array($token) && $token[0] === T_LIST) {
53                    // T_LIST トークンが見つかった場合、その行番号を記録
54                    $linesFoundInFile[] = $token[2];
55                }
56            }
57
58            // ファイル内で `list()` 構文が見つかった場合
59            if (!empty($linesFoundInFile)) {
60                // 同じ行番号が複数回記録されることを防ぐため、重複を除去
61                $foundListConstructs[$file] = array_unique($linesFoundInFile);
62            }
63        }
64    }
65
66    return $foundListConstructs;
67}
68
69// --- サンプルコードの実行例 ---
70
71// 現在のスクリプトがあるディレクトリを対象とします。
72// テスト用に、このディレクトリ内にlist()構文を含むPHPファイルを作成すると確認できます。
73$targetDirectory = __DIR__;
74
75echo "Scanning PHP files in '{$targetDirectory}' for 'list()' constructs..." . PHP_EOL;
76
77// 関数を呼び出し、結果を取得
78$results = findListConstructsInPhpFiles($targetDirectory);
79
80// 結果の出力
81if (empty($results)) {
82    echo "No 'list()' constructs found in PHP files in '{$targetDirectory}'." . PHP_EOL;
83} else {
84    echo "Files containing 'list()' constructs:" . PHP_EOL;
85    foreach ($results as $fileName => $lines) {
86        echo "- {$fileName}: Found on lines " . implode(', ', $lines) . PHP_EOL;
87    }
88}
89
90// 例として、このスクリプト自身も T_LIST を含んでいる可能性があるため、
91// その結果が表示されることを期待できます。
92
93?>

このPHPサンプルコードは、PHPの内部でコードがどのように解析されるかを示すT_LIST定数を利用し、指定されたディレクトリ内のPHPファイルからlist()構文、または[$a, $b] = ...;のような配列デストラクチャリング構文が使用されている箇所を特定します。T_LISTはPHPがコードをトークンに分解する際にlistキーワードを識別するための内部定数で、整数値を持ちます。

findListConstructsInPhpFiles関数は、文字列型の引数$directoryPathでスキャン対象のディレクトリパスを受け取ります。この関数は、ディレクトリ内の各PHPファイルを順に読み込み、token_get_all()関数を用いてそのPHPコードを構成するトークン群に分割します。その後、個々のトークンがT_LIST定数に該当するかどうかを検査し、もし該当するトークンが見つかれば、そのトークンが存在する行番号を記録します。関数の戻り値は、見つかった構文を含むファイル名をキーとし、そのファイル内でlist()構文が見つかったすべての行番号の配列を値とする連想配列（array<string, array<int>>）です。

このコードは、ご自身のPHPプロジェクトで特定の構文がどこで使われているかを調査したい場合や、コードベース全体でのコーディング規約の遵守状況を確認する際などに役立ちます。システムエンジニアを目指す方にとって、PHPがソースコードをどのように解釈しているかを理解する一助となるでしょう。

Copy
1<?php
2
3/**
4 * T_LIST トークン定数と list() 構文の使用法をデモンストレーションします。
5 *
6 * T_LIST はPHPの内部で 'list' キーワードを表すトークンID (整数値) です。
7 * 通常のPHPアプリケーションコードで直接使用されることは稀ですが、
8 * PHPがコードをどのように解析するかを理解するのに役立ちます。
9 *
10 * PHP 8 以降では、list() 構文よりも短縮構文 (例: `[$a, $b] = $array;`) が推奨されています。
11 */
12function demonstrateListAndTList(): void
13{
14    // list() 構文を含むPHPコードスニペット
15    $codeSnippet = '<?php list($a, $b) = [1, 2];';
16
17    // token_get_all() を使用してコードをトークンに分解します。
18    // T_LIST 定数は、このトークンリスト内で list() 構文の出現として現れます。
19    $tokens = token_get_all($codeSnippet);
20
21    echo "--- コードスニペットのトークン解析 ---\n";
22    echo "解析対象コード: '" . $codeSnippet . "'\n\n";
23
24    $tListConstantFound = false;
25    foreach ($tokens as $token) {
26        if (is_array($token)) {
27            // トークンが配列の場合: [トークンID, トークン文字列, 行番号]
28            // T_LIST はトークンIDであり、整数値です。
29            echo sprintf("  ID: %-5s ('%s'), Text: '%s', Line: %d\n", $token[0], token_name($token[0]), $token[1], $token[2]);
30            if ($token[0] === T_LIST) {
31                echo "  ↑ ここで T_LIST 定数 (値: " . T_LIST . ") が見つかりました。\n";
32                $tListConstantFound = true;
33            }
34        } else {
35            // トークンが単一文字の場合 (例: '=', ';')
36            echo sprintf("  Text: '%s'\n", $token);
37        }
38    }
39
40    if (!$tListConstantFound) {
41        echo "\n注意: 提供されたコードスニペットでは T_LIST 定数が見つかりませんでした。\n";
42    }
43    echo "\n";
44
45    echo "--- list() 構文の実際の使用例 (PHP 8 の文脈) ---\n";
46    $data = ['apple', 'banana', 'cherry', 'date'];
47
48    echo "元の配列: [\"" . implode('", "', $data) . "\"]\n\n";
49
50    // 1. 配列の要素を個別の変数に代入する list() 構文
51    // T_LIST 定数はこの構文を内部的に表します。
52    list($fruit1, $fruit2) = $data;
53    echo "1. list() を使用した代入: \$fruit1 = '{$fruit1}', \$fruit2 = '{$fruit2}'\n";
54
55    // 2. PHP 8 で推奨される短縮構文 (list() と同じ機能を提供)
56    [$fruitA, $fruitB] = $data;
57    echo "2. 短縮構文 ([]) を使用した代入: \$fruitA = '{$fruitA}', \$fruitB = '{$fruitB}'\n";
58
59    // 3. 要素をスキップする例 (list() と短縮構文の両方で可能)
60    // null または空の要素を指定することで、その位置の要素をスキップできます。
61    list(null, $fruitC, , $fruitD) = $data;
62    echo "3. list() で要素をスキップ (nullまたは空で指定): \$fruitC = '{$fruitC}', \$fruitD = '{$fruitD}'\n";
63
64    [$fruitE, , $fruitF] = $data;
65    echo "4. 短縮構文 ([]) で要素をスキップ (空で指定): \$fruitE = '{$fruitE}', \$fruitF = '{$fruitF}'\n";
66}
67
68// 関数を実行してデモンストレーションを開始
69demonstrateListAndTList();
70

PHPのT_LISTは、PHP内部で'list'キーワードを表すトークンIDの定数で、整数値を持ちます。この定数に引数はなく、整数値を返します。通常のアプリケーションコードで直接使用する機会は少ないですが、PHPがコードをどのように解釈・解析するかを理解する上で役立ちます。サンプルコードでは、token_get_all()関数を使ってPHPコードをトークンに分解する際に、listキーワードがT_LISTとして識別される様子を示しています。

list()構文は、配列の要素を複数の変数に一度に代入するための機能です。例えば、list($fruit1, $fruit2) = $data;のように使用し、配列の要素を変数に展開できます。PHP 8以降では、list()構文の代わりに[$fruitA, $fruitB] = $data;といった短縮構文が推奨されており、同じ機能を提供し、より簡潔に記述できます。

また、配列の特定の要素をスキップして代入したい場合は、list(null, $fruitC, , $fruitD) = $data;のように、その位置にnullや空の要素を記述することで実現できます。この機能も短縮構文で同様に利用可能です。サンプルコードは、T_LISTの内部的な役割に触れつつ、list()構文と推奨される短縮構文の実用的な使い方、特に配列からの変数への代入や要素のスキップ方法を具体的にデモンストレーションしています。