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

Copy
1<?php
2
3/**
4 * 2つの整数を加算し、その合計を整数として返します。
5 * PHP 8で導入された戻り値の型宣言 (int) を使用し、
6 * 関数が常に整数を返すことを保証します。
7 *
8 * T_RETURNは、PHPの内部で 'return' キーワードを識別するために使われるトークン定数です。
9 *
10 * @param int $a 最初の整数
11 * @param int $b 2番目の整数
12 * @return int 2つの整数の合計
13 */
14function addNumbers(int $a, int $b): int
15{
16    // 'return' キーワードは、関数の結果を呼び出し元に返します。
17    // PHP 8では、このように戻り値の型を宣言することが推奨されます。
18    return $a + $b;
19}
20
21// 関数の使用例
22$sum = addNumbers(10, 20);
23echo "合計: " . $sum . PHP_EOL; // 出力例: 合計: 30
24
25// 期待される型以外の値を渡すと TypeError が発生します（PHP 8の機能）。
26// 例: addNumbers("five", 2); // この行は実行時にエラーとなります。
27
28?>

このサンプルコードは、2つの整数を加算し、その合計を整数として返すaddNumbers関数を定義しています。

まず、addNumbers(int $a, int $b)のように、引数$aと$bにintという型が指定されています。これは、関数に渡される値が必ず整数であることを保証するための「引数の型宣言」です。これにより、意図しない型のデータが渡されるのを防ぎます。

次に、関数名の後にある: intという記述は、PHP 8で導入された「戻り値の型宣言」です。これは、このaddNumbers関数が常に整数（int）を返すことを明示的に宣言しています。これにより、関数を利用する側は、戻り値が確実に整数であると信頼でき、プログラム全体の堅牢性が向上します。もし関数が整数以外の値を返そうとした場合、PHPはTypeErrorを発生させて問題を通知します。

関数内部ではreturn $a + $b;という行があり、returnキーワードは関数の実行を終了し、計算された$a + $bの結果を呼び出し元に渡す役割を果たします。

なお、T_RETURNという名前は、PHPの内部でreturnキーワードを識別するために使われる特別な定数です。これは通常のプログラミングで直接使用するものではなく、PHPがコードを解析する際に利用するものです。

このように、PHP 8の型宣言を活用することで、より安全で保守しやすいコードを書くことができます。

Copy
1<?php
2
3/**
4 * オブジェクト指向プログラミングにおけるメソッドチェーンの例です。
5 * メソッドが自身 ($this) を返すことで、複数のメソッド呼び出しを連続して記述できます。
6 *
7 * PHPの内部では、'return' キーワードは 'T_RETURN' という定数で表されるトークンとして認識されます。
8 * このサンプルコードでは、その 'return' キーワードの活用方法の一つとして、
9 * 現在のオブジェクトを返す ('return $this;') パターンを示しています。
10 */
11class FluentCalculator
12{
13    private float $result;
14
15    /**
16     * コンストラクタで初期値を設定します。
17     *
18     * @param float $initialValue 計算の開始値
19     */
20    public function __construct(float $initialValue = 0.0)
21    {
22        $this->result = $initialValue;
23    }
24
25    /**
26     * 現在の結果に数値を加算し、現在のオブジェクト自身を返します。
27     * これにより、次のメソッドをチェーンして呼び出すことが可能になります。
28     *
29     * @param float $number 加算する数値
30     * @return self 現在のFluentCalculatorオブジェクト
31     */
32    public function add(float $number): self
33    {
34        $this->result += $number;
35        return $this; // 現在のオブジェクト自身を返すことでメソッドチェーンを可能にします
36    }
37
38    /**
39     * 現在の結果から数値を減算し、現在のオブジェクト自身を返します。
40     *
41     * @param float $number 減算する数値
42     * @return self 現在のFluentCalculatorオブジェクト
43     */
44    public function subtract(float $number): self
45    {
46        $this->result -= $number;
47        return $this; // 現在のオブジェクト自身を返すことでメソッドチェーンを可能にします
48    }
49
50    /**
51     * 現在の計算結果を取得します。
52     * このメソッドは最終結果を返すため、自身を返しません。
53     *
54     * @return float 現在の計算結果
55     */
56    public function getResult(): float
57    {
58        return $this->result;
59    }
60}
61
62// FluentCalculatorクラスの利用例
63// 初期値100.0で計算機を作成
64$calculator = new FluentCalculator(100.0);
65
66// メソッドチェーンを使用して複数の操作を簡潔に連続して実行します。
67// 各 'add' や 'subtract' メソッドが '$this' を返すため、
68// その直後に次のメソッドを呼び出すことができます。
69$finalResult = $calculator->add(50.0)      // 100 + 50 = 150
70                          ->subtract(20.0) // 150 - 20 = 130
71                          ->add(10.5)      // 130 + 10.5 = 140.5
72                          ->getResult();   // 最終結果を取得
73
74echo "最終的な計算結果: " . $finalResult . PHP_EOL; // 出力: 最終的な計算結果: 140.5
75
76// 別のチェーンの例
77$anotherResult = (new FluentCalculator(0)) // 初期値0で新しいインスタンスを作成
78                 ->add(5)
79                 ->add(3)
80                 ->subtract(2)
81                 ->getResult();
82
83echo "別の計算結果: " . $anotherResult . PHP_EOL; // 出力: 別の計算結果: 6

PHP内部では、returnキーワードはT_RETURNという定数で表されるトークンとして認識されます。このサンプルコードは、そのreturnキーワードの応用の一つである「メソッドチェーン」を示しており、オブジェクトのメソッドを連続して呼び出すことで、複数の操作を簡潔に記述し、コードの可読性を高める手法です。

このメソッドチェーンを実現する鍵は、各メソッドがreturn $this;と記述し、現在実行中のオブジェクト自身を戻り値として返すことです。$thisは現在実行中のオブジェクトを指します。例えば、FluentCalculatorクラスのaddやsubtractメソッドは、数値を引数で受け取り計算後、return $thisによって自身のオブジェクトを戻します。これにより、$calculator->add(50.0)->subtract(20.0)のように、続けて次のメソッドを呼び出すことが可能になります。

最終結果を取得するgetResultメソッドは、オブジェクト自身ではなく、計算された数値（float型）を戻り値として返します。このようにreturn $thisを用いることで、一連の操作を流れるように記述し、簡潔で分かりやすいコード作成が可能です。