【PHP8.x】PhpToken::__construct()メソッドの使い方

__constructメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2026年02月08日

基本的な使い方

__constructメソッドは、PhpTokenクラスの新しいインスタンスを初期化する際に実行される特殊なメソッドです。PhpTokenクラスはPHP 8で導入されたもので、PHPのソースコードを構成する個々の最小単位、例えばキーワード、変数名、演算子といった要素を「トークン」として表現するために使用されます。

この__constructメソッドの主な役割は、新しいPhpTokenオブジェクトが生成される際に、そのオブジェクトが表すトークンの具体的な情報を設定することです。具体的には、トークンの種類を示す識別子（ID）、実際のトークン文字列（テキスト）、ソースコード中の該当行番号、そしてファイル内での開始位置といった詳細なデータを、オブジェクトの内部状態として初期化します。これにより、作成されたPhpTokenオブジェクトは、どの部分のソースコードがどのような意味を持つトークンであるかを正確に記録します。

通常、システムエンジニアがこの__constructメソッドを直接呼び出してPhpTokenオブジェクトを生成することは稀です。多くの場合、PhpToken::getAll()のようなファクトリメソッドがPHPのソースコード全体を解析し、その解析結果に基づいて適切な情報を持つPhpTokenオブジェクトの配列を自動的に生成します。このプロセスの中で、内部的に各PhpTokenオブジェクトの初期化のためにこの__constructメソッドが利用されます。この仕組みは、PHPのコードをプログラム的に解析し、静的解析ツールや開発支援ツールなどを構築する際の基盤として非常に重要です。このメソッドは、ソースコードの構造を理解し、操作するためのPhpTokenオブジェクトの正確な生成を支える、内部的ながらも不可欠な要素と言えます。

構文(syntax)


1new PhpToken(T_STRING, 'myVariable', 1, 0, 'example.php');

引数(parameters)

int $id, string $text, int $line = -1, int $pos = -1

int $id: トークンのIDを指定する整数
string $text: トークンに含まれるテキストを指定する文字列
int $line = -1: トークンが含まれる行番号を指定する整数（デフォルトは-1）
int $pos = -1: トークンが含まれる位置を指定する整数（デフォルトは-1）

戻り値(return)

戻り値なし

戻り値はありません

サンプルコード

PhpTokenクラスのコンストラクタを理解する


1<?php
2
3// PhpTokenクラスのコンストラクタ (__construct) の使用例
4
5// PhpToken::__construct(int $id, string $text, int $line = -1, int $pos = -1)
6// このコンストラクタは、指定されたトークンID、テキスト内容、およびオプションでコード内の行と位置情報を持つ
7// 新しい PhpToken オブジェクトを作成します。
8
9// 1. 最低限の引数（IDとテキスト）で PhpToken インスタンスを作成
10// IDには、PHPの組み込みトークン定数（例: T_ECHO, T_VARIABLE）または単一文字のASCII値を使用します。
11$token1 = new PhpToken(T_ECHO, 'echo');
12
13echo "--- Token 1 (echo キーワード) ---" . PHP_EOL;
14echo "ID: " . $token1->id . " (意味: " . token_name($token1->id) . ")" . PHP_EOL;
15echo "Text: '" . $token1->text . "'" . PHP_EOL;
16// 行番号と位置は指定されていないため、デフォルト値の -1 になります。
17echo "Line: " . $token1->line . PHP_EOL;
18echo "Position: " . $token1->pos . PHP_EOL;
19echo PHP_EOL;
20
21// 2. 行番号と位置も指定して PhpToken インスタンスを作成
22// これにより、実際のPHPコード内のトークンの位置をシミュレートできます。
23$token2 = new PhpToken(T_VARIABLE, '$userName', 5, 12);
24
25echo "--- Token 2 (\$userName 変数) ---" . PHP_EOL;
26echo "ID: " . $token2->id . " (意味: " . token_name($token2->id) . ")" . PHP_EOL;
27echo "Text: '" . $token2->text . "'" . PHP_EOL;
28echo "Line: " . $token2->line . PHP_EOL;
29echo "Position: " . $token2->pos . PHP_EOL;
30echo PHP_EOL;
31
32// 3. ASCII文字を表す PhpToken インスタンスを作成 (例: セミコロン)
33// 単一の記号トークンでは、その文字のASCII値がIDとして使われることがあります。
34$token3 = new PhpToken(ord(';'), ';', 8, 20);
35
36echo "--- Token 3 (セミコロン) ---" . PHP_EOL;
37echo "ID: " . $token3->id . " (ASCII文字: " . chr($token3->id) . ")" . PHP_EOL;
38echo "Text: '" . $token3->text . "'" . PHP_EOL;
39echo "Line: " . $token3->line . PHP_EOL;
40echo "Position: " . $token3->pos . PHP_EOL;
41echo PHP_EOL;
42
43?>

PhpTokenクラスの__constructは、PHPコードの構成要素である「トークン」を表すオブジェクトを生成するコンストラクタです。

このメソッドは、トークンの種類を示すint $idと、その文字列内容であるstring $textを必須引数として受け取ります。$idには、T_ECHOのようなPHP組み込み定数や、セミコロンのような単一文字のASCII値が使われます。さらに任意で、コード内でのトークンの行番号int $lineと、その行内での開始位置int $posも指定可能です。

サンプルコードでは、キーワード（例: echo）、変数（例: $userName）、記号（例: セミコロン）など、様々な種類のトークンをこれらの引数を用いて作成する例を示しています。__constructは、指定された情報でPhpTokenオブジェクトを初期化し、これらの情報をオブジェクトのプロパティに設定します。このメソッド自体は、値を直接返さず、オブジェクトを生成する役割を担います。この機能は、PHPコードの構文解析や、関連するツール開発の基盤として利用されます。

PhpTokenクラスのコンストラクタは、PHPコードの字句解析（コードを最小単位に分解する処理）に用いられる内部的なクラスです。一般的なアプリケーション開発で直接このコンストラクタを使ってトークンを生成することは稀で、主にPHPの静的解析ツールなどを開発する際に利用されます。

引数$idはトークンの種類を示す重要な引数です。T_EECHOのようなPHPの組み込みトークン定数、またはセミコロンなどの記号を表すASCII値（例: ord(';')）を正しく指定してください。$idが示すトークンの種類と$textで指定する実際の文字列は、意味的に一致させてください。不適切な組み合わせは意図しないトークン情報となり、コード解析ツールなどで予期せぬ結果を招く可能性があります。

$lineと$posはコード内の行と位置の情報であり、省略するとデフォルト値の-1となります。これらは主にPHPの内部処理や開発ツールで利用される補助情報です。

PhpTokenコンストラクタでトークンを生成する


1<?php
2
3/**
4 * PhpToken::__construct はPHP 8で導入されたメソッドです。
5 * このクラスは、PHPコードをトークンに分解した結果の各要素（トークン）を表現します。
6 * 通常は PhpToken::tokenize() 関数がこれらのオブジェクトを生成しますが、__construct を使って手動で作成することも可能です。
7 */
8
9// 例1: PHPのキーワード 'echo' のトークンを作成
10// T_ECHO は 'echo' キーワードのトークンIDを示す定数です。
11// 第二引数はトークンのテキスト内容、第三引数は行番号、第四引数はファイル内でのバイトオフセットです。
12$tokenEcho = new PhpToken(T_ECHO, 'echo', 1, 0);
13
14echo "--- トークン1: キーワード 'echo' ---\n";
15echo "ID (数値): " . $tokenEcho->id . " (" . token_name($tokenEcho->id) . ")\n";
16echo "テキスト: '" . $tokenEcho->text . "'\n";
17echo "行番号: " . $tokenEcho->line . "\n";
18echo "位置 (バイトオフセット): " . $tokenEcho->pos . "\n\n";
19
20// 例2: 変数 '$myVariable' のトークンを作成
21// T_VARIABLE は変数名のトークンIDです。
22$tokenVariable = new PhpToken(T_VARIABLE, '$myVariable', 5, 20);
23
24echo "--- トークン2: 変数 '$myVariable' ---\n";
25echo "ID (数値): " . $tokenVariable->id . " (" . token_name($tokenVariable->id) . ")\n";
26echo "テキスト: '" . $tokenVariable->text . "'\n";
27echo "行番号: " . $tokenVariable->line . "\n";
28echo "位置 (バイトオフセット): " . $tokenVariable->pos . "\n\n";
29
30// 例3: セミコロン ';' のトークンを作成
31// ASCII文字のような単一の文字トークンの場合、その文字のASCIIコードをIDとして使用します。
32$tokenSemicolon = new PhpToken(ord(';'), ';', 7, 30);
33
34echo "--- トークン3: セミコロン ';' ---\n";
35echo "ID (数値): " . $tokenSemicolon->id . " (" . token_name($tokenSemicolon->id) . ")\n";
36echo "テキスト: '" . $tokenSemicolon->text . "'\n";
37echo "行番号: " . $tokenSemicolon->line . "\n";
38echo "位置 (バイトオフセット): " . $tokenSemicolon->pos . "\n\n";
39
40// 例4: デフォルト引数（行番号と位置）の使用
41// 行番号と位置はオプション引数のため、省略するとデフォルト値（-1）が設定されます。
42$tokenString = new PhpToken(T_STRING, 'MyClassName');
43
44echo "--- トークン4: 文字列 'MyClassName' (デフォルト引数) ---\n";
45echo "ID (数値): " . $tokenString->id . " (" . token_name($tokenString->id) . ")\n";
46echo "テキスト: '" . $tokenString->text . "'\n";
47echo "行番号: " . $tokenString->line . "\n"; // デフォルト値 -1
48echo "位置 (バイトオフセット): " . $tokenString->pos . "\n\n"; // デフォルト値 -1
49
50?>

PhpToken::__constructは、PHP 8で導入されたPhpTokenクラスのコンストラクタです。このメソッドは、PHPコードを構成する個々の要素である「トークン」を表現するPhpTokenオブジェクトを手動で作成するために使われます。通常はPhpToken::tokenize()関数がPHPコードを解析してこれらのオブジェクトを自動で生成しますが、このコンストラクタを使えば直接生成することも可能です。

引数として、まず$id（整数）でトークンの種類を示すIDを指定します。これはT_ECHOのようなPHP定義の定数や、セミコロンのような単一文字のASCIIコードです。次に$text（文字列）で、そのトークンが持つ実際のテキスト内容（例: 'echo' や '$myVariable'）を指定します。残りの引数$lineと$posはオプションで、それぞれトークンが元のソースコードの何行目にあるか、ファイル先頭から何バイト目の位置にあるかを示す整数値です。これらを省略した場合、デフォルト値として-1が設定されます。

コンストラクタであるため戻り値はありませんが、new PhpToken(...)という構文で新しいPhpTokenオブジェクトが生成されます。サンプルコードでは、キーワード、変数、記号など様々な種類のトークンを手動で作成し、生成されたオブジェクトのid、text、line、posプロパティを通じて、それぞれのトークン情報にアクセスできることを示しています。また、token_name()関数を使うことで、数値のIDが示す具体的なトークン名を分かりやすく表示しています。

このPhpTokenクラスは、PHPコードを解析するための専門的な機能を提供し、通常のアプリケーション開発で直接利用する機会は稀です。PHP 8以降でのみ使用可能ですので、実行環境のバージョンにご注意ください。コンストラクタの$id引数には、T_ECHOのようなPHPの定義済みトークンIDか、セミコロンなどの単一文字のASCIIコードを指定します。$text引数には、そのIDに対応する実際の文字列を正確に指定する必要があります。これらが一致しない場合、作成されるトークンは意図したものではなくなります。行番号と位置の引数は省略できますが、コード解析時には重要な情報となります。まずは、PhpToken::tokenize()でトークンリストを生成する基本的な使い方を理解することから始めるのが良いでしょう。