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

Copy
1<?php
2
3/**
4 * 抽象クラスの概念を示す例。
5 * 図形を表す抽象クラス。
6 * 抽象クラスは直接インスタンス化できず、必ず継承して使われます。
7 * 'abstract' キーワードは、このクラスが完全な実装を持たず、
8 * 継承先で特定のメソッド（抽象メソッド）の実装が必須であることを示します。
9 * (PHPの内部的には、この'abstract'キーワードがT_ABSTRACTというトークンとして認識されます。)
10 */
11abstract class AbstractShape
12{
13    /**
14     * すべての具象図形が実装しなければならない抽象メソッド。
15     * 面積を計算して返します。
16     * 抽象メソッドは本体（処理内容）を持たず、継承先のクラスで具体的な実装が強制されます。
17     */
18    abstract public function calculateArea(): float;
19
20    /**
21     * 具象クラスで共有される一般的なメソッド。
22     * これは抽象メソッドではないため、具体的な実装を持ちます。
23     * static::class は、このメソッドを呼び出した具象クラスの名前を返します。
24     */
25    public function getShapeName(): string
26    {
27        // クラス名から"Shape"という接尾辞を除いた部分を返します（例: CircleShape -> Circle）
28        return str_replace('Shape', '', static::class);
29    }
30}
31
32/**
33 * トレイトの概念を示す例。
34 * ログ出力機能を提供するトレイト。
35 * トレイトはクラスに再利用可能なメソッド群を「コピー＆ペースト」するような形で組み込むために使用されます。
36 * 複数のクラスで共通の機能を使いたいが、多重継承ができないPHPにおいて、コードの再利用性を高めます。
37 */
38trait LoggerTrait
39{
40    /**
41     * メッセージをログとして出力します。
42     * 実際にはファイルやデータベースに出力することが多いですが、ここでは簡易的にコンソールに出力します。
43     *
44     * @param string $message 出力するメッセージ
45     */
46    public function log(string $message): void
47    {
48        echo "[LOG] " . date('Y-m-d H:i:s') . " - " . $message . PHP_EOL;
49    }
50}
51
52/**
53 * 具象クラスの例：円。
54 * AbstractShapeを継承し、LoggerTraitを使用します。
55 * 抽象クラスを継承するため、AbstractShapeの抽象メソッドcalculateAreaの実装が必須です。
56 * 'use LoggerTrait;' でLoggerTraitのメソッドがこのクラスに組み込まれます。
57 */
58class Circle extends AbstractShape
59{
60    use LoggerTrait; // LoggerTraitのメソッド（log()）をクラスに組み込む
61
62    private float $radius;
63
64    public function __construct(float $radius)
65    {
66        $this->radius = $radius;
67        // トレイトで提供されるlogメソッドを利用
68        $this->log("Circleインスタンスが半径: {$radius}で作成されました。");
69    }
70
71    /**
72     * AbstractShapeの抽象メソッド calculateArea を実装します。
73     * 円の面積を計算します。
74     */
75    public function calculateArea(): float
76    {
77        $area = M_PI * $this->radius * $this->radius;
78        // トレイトで提供されるlogメソッドを利用
79        $this->log($this->getShapeName() . "の面積を計算しました: {$area}");
80        return $area;
81    }
82
83    public function getRadius(): float
84    {
85        return $this->radius;
86    }
87}
88
89/**
90 * 具象クラスの例：四角形。
91 * AbstractShapeを継承し、LoggerTraitを使用します。
92 * こちらもCircleクラスと同様に、抽象クラスとトレイトの恩恵を受けます。
93 */
94class Rectangle extends AbstractShape
95{
96    use LoggerTrait; // LoggerTraitのメソッド（log()）をクラスに組み込む
97
98    private float $width;
99    private float $height;
100
101    public function __construct(float $width, float $height)
102    {
103        $this->width = $width;
104        $this->height = $height;
105        // トレイトで提供されるlogメソッドを利用
106        $this->log("Rectangleインスタンスが幅: {$width}, 高さ: {$height}で作成されました。");
107    }
108
109    /**
110     * AbstractShapeの抽象メソッド calculateArea を実装します。
111     * 四角形の面積を計算します。
112     */
113    public function calculateArea(): float
114    {
115        $area = $this->width * $this->height;
116        // トレイトで提供されるlogメソッドを利用
117        $this->log($this->getShapeName() . "の面積を計算しました: {$area}");
118        return $area;
119    }
120
121    public function getWidth(): float
122    {
123        return $this->width;
124    }
125
126    public function getHeight(): float
127    {
128        return $this->height;
129    }
130}
131
132// === サンプルコードの実行部分 ===
133
134// 抽象クラスは直接インスタンス化できません。
135// 以下の行を実行するとFatal Errorが発生します:
136// $shape = new AbstractShape();
137
138// 円のインスタンスを作成し、メソッドを呼び出します。
139$circle = new Circle(5);
140echo "円の半径: " . $circle->getRadius() . PHP_EOL;
141echo "円の面積: " . $circle->calculateArea() . PHP_EOL;
142echo "円の名前: " . $circle->getShapeName() . PHP_EOL;
143// トレイトのlogメソッドを直接呼び出すことも可能
144$circle->log("円の処理が完了しました。");
145
146echo PHP_EOL; // 見やすくするために改行
147
148// 四角形のインスタンスを作成し、メソッドを呼び出します。
149$rectangle = new Rectangle(4, 6);
150echo "四角形の幅: " . $rectangle->getWidth() . PHP_EOL;
151echo "四角形の高さ: " . $rectangle->getHeight() . PHP_EOL;
152echo "四角形の面積: " . $rectangle->calculateArea() . PHP_EOL;
153echo "四角形の名前: " . $rectangle->getShapeName() . PHP_EOL;
154// トレイトのlogメソッドを直接呼び出すことも可能
155$rectangle->log("四角形の処理が完了しました。");

このPHPサンプルコードは、abstract（抽象クラス・抽象メソッド）とtraitの概念を初心者向けに解説しています。

abstractキーワードは、直接インスタンス化できない「抽象クラス」や、継承先のクラスで必ず実装が必要な「抽象メソッド」を定義します。これにより、プログラムの共通設計を強制し、一貫性を保ちます。例えばAbstractShapeクラスは抽象クラスで、calculateArea()という抽象メソッドを持ちます。このメソッドは引数なしで面積を計算し、float型で結果を返します。getShapeName()メソッドは引数なしでクラス名を返し、これは抽象メソッドではありません。

traitは、PHPで多重継承ができない制約に対し、複数のクラスで共通の機能（メソッド群）を再利用するための仕組みです。LoggerTraitはlog(string $message): voidメソッドを提供し、渡された文字列メッセージをログとして出力します。このメソッドは引数としてstring型のメッセージを受け取り、戻り値はありません。

CircleクラスとRectangleクラスはAbstractShapeを継承し、抽象メソッドであるcalculateArea()をそれぞれ具体的な計算方法で実装しています。また、use LoggerTrait;と記述することで、LoggerTraitで定義されたlog()メソッドがこれらのクラスで利用可能になります。これにより、コードの重複を避けつつ、共通のロギング機能を持つ具象クラスを効率的に作成できることを示しています。

Copy
1<?php
2
3/**
4 * 指定されたPHPコード文字列を解析し、トークン情報を表示します。
5 * T_ABSTRACT (キーワード 'abstract') と T_STRING (識別子) を特に強調して表示し、
6 * システムエンジニアを目指す初心者がトークンの概念を理解するのに役立ちます。
7 *
8 * @param string $code 解析するPHPコードの文字列
9 * @return void
10 */
11function analyzePhpTokens(string $code): void
12{
13    echo "--- 解析対象のPHPコード ---\n";
14    echo $code . "\n\n";
15    echo "--- トークン解析結果 ---\n";
16
17    // PHPコードをトークンの配列に分解します。
18    // 各トークンは、ID (定数), 文字列値, 行番号を含む配列、
19    // または単一の文字（例えば、セミコロンや波括弧など）になります。
20    $tokens = token_get_all($code);
21
22    foreach ($tokens as $token) {
23        if (is_array($token)) {
24            // トークンが配列形式の場合 (例: [トークンID, トークン値, 行番号])
25            $tokenId = $token[0];         // トークンのID (例: T_ABSTRACT, T_STRINGなど)
26            $tokenValue = $token[1];      // トークンの実際の文字列 (例: "abstract", "MyClass"など)
27            $lineNumber = $token[2];      // コード内でのトークンの行番号
28
29            // token_name() 関数はトークンID (整数) を人間が読める文字列名に変換します。
30            $tokenName = token_name($tokenId);
31
32            // T_ABSTRACT は 'abstract' キーワードを表すトークンです。
33            if ($tokenId === T_ABSTRACT) {
34                echo sprintf("行 %d: [T_ABSTRACT] (キーワード 'abstract'): '%s'\n", $lineNumber, $tokenValue);
35            }
36            // T_STRING はクラス名、関数名、変数名などの識別子を表すトークンです。
37            elseif ($tokenId === T_STRING) {
38                echo sprintf("行 %d: [T_STRING] (識別子): '%s'\n", $lineNumber, $tokenValue);
39            }
40            // その他のトークン
41            else {
42                echo sprintf("行 %d: [%s]: '%s'\n", $lineNumber, $tokenName, $tokenValue);
43            }
44        } else {
45            // トークンが単一文字の場合 (例: '{', ';', '$' など)
46            echo sprintf("特殊文字: '%s'\n", $token);
47        }
48    }
49}
50
51// 解析するPHPコードの例を定義します。
52// ここには 'abstract' キーワードと、様々な識別子 (T_STRING) が含まれます。
53$phpCodeExample = <<<'EOD'
54<?php
55
56abstract class MyAbstractClass
57{
58    // T_STRING の例: $myProperty, MyAbstractClass, myMethod, string, int など
59    public string $myProperty = "Hello";
60    protected int $value = 123;
61
62    abstract public function myMethod(string $param): void;
63
64    public function processValue(): void
65    {
66        echo "Processing " . $this->value . "\n";
67    }
68}
69
70class ConcreteClass extends MyAbstractClass
71{
72    public function myMethod(string $param): void
73    {
74        echo "Concrete method called with: " . $param . "\n";
75    }
76}
77
78// T_STRING の例: $instance, ConcreteClass, new, processValue, myMethod
79$instance = new ConcreteClass();
80$instance->myProperty = "World";
81$instance->processValue();
82$instance->myMethod("PHP is great!");
83
84EOD;
85
86// 上記のPHPコード例を解析し、結果を表示します。
87analyzePhpTokens($phpCodeExample);
88

このサンプルコードは、PHPコードがどのように小さな要素（トークン）に分解されるかという概念を、システムエンジニアを目指す初心者にも分かりやすく説明します。analyzePhpTokens関数は、解析したいPHPコードの文字列を引数として受け取り、token_get_all関数を用いてそのコードをトークンの配列に分解します。この関数自体は特定の値を返しませんが、解析結果を画面に表示します。

分解された各トークンは、その種類（ID）と実際の文字列値、コード中の行番号の情報を持っています。特に、T_ABSTRACTはPHPの予約語である「abstract」を表す定数で、抽象クラスや抽象メソッドを定義する際に使われます。一方、T_STRINGは、クラス名、関数名、変数名など、プログラマーがコード内で定義する「識別子」を表す定数です。

コードは各トークンを検査し、特にT_ABSTRACTとT_STRINGの場合にはその種類を強調して表示します。この解析結果を通じて、PHPコードがキーワードや識別子といった要素にどのように分類され、PHPエンジンによって処理されるのか、その基本的な仕組みを理解することができます。