【PHP8.x】ReflectionObject::IS_FINAL定数の使い方

Copy
1<?php
2
3/**
4 * finalキーワードで宣言されたクラスは、他のクラスから継承（拡張）することを禁止します。
5 * これは、クラスの設計が完全に決定されており、それ以上の変更やサブクラス化を許可しない場合に利用されます。
6 */
7final class ImmutableConfig
8{
9    private string $setting;
10
11    public function __construct(string $initialSetting)
12    {
13        $this->setting = $initialSetting;
14    }
15
16    public function getSetting(): string
17    {
18        return $this->setting;
19    }
20}
21
22// キーワード: "php is declared final and cannot be doubled"
23// finalクラスを継承しようとすると、PHPは致命的なエラー(Fatal error)を発生させます。
24// 下記のコメントアウトを解除すると、このエラーを確認できます。
25/*
26class ExtendedConfig extends ImmutableConfig
27{
28    // Fatal error: Class ExtendedConfig may not inherit from final class ImmutableConfig
29}
30*/
31
32/**
33 * オブジェクトのリフレクションを使用して、そのクラスがfinalであるかを判定する関数です。
34 * ReflectionObjectクラスは、特定のオブジェクトインスタンスに関する情報を提供します。
35 * クラスのfinal性を判定するためには、ReflectionObject::getModifiers()メソッドが返す修飾子と、
36 * ReflectionClass::IS_FINAL定数（final修飾子を表すビットマスク）を組み合わせて使用します。
37 *
38 * (PHP 8のリファレンスではReflectionObject::IS_FINALという定数は直接存在しませんが、
39 *  ReflectionObject::getModifiers()はReflectionClass::getModifiers()と同じビットマスクを返し、
40 *  ReflectionClass::IS_FINALを用いて評価することが可能です。)
41 */
42function checkFinalStatusUsingReflection(): void
43{
44    echo "--- Final Class and Reflection Demonstration ---\n\n";
45
46    // finalキーワードで宣言されたクラスのインスタンスを作成
47    $configInstance = new ImmutableConfig("Production Mode");
48
49    // ReflectionObjectを使用して、インスタンスのクラス情報を取得
50    $reflector = new ReflectionObject($configInstance);
51
52    echo "Checking class for object of type: " . $reflector->getName() . "\n";
53
54    // getModifiers()はクラスの修飾子（public, private, finalなど）を示すビットマスクを返します。
55    // ReflectionClass::IS_FINAL定数は、final修飾子に対応するビット値です。
56    if ($reflector->getModifiers() & ReflectionClass::IS_FINAL) {
57        echo "  - This class is declared as FINAL.\n";
58        echo "  - This means it cannot be inherited or extended by other classes.\n";
59        echo "  - (This behavior relates directly to the keyword: 'php is declared final and cannot be doubled')\n";
60    } else {
61        echo "  - This class is NOT final.\n";
62    }
63
64    echo "\nAccessing object method: " . $configInstance->getSetting() . "\n";
65
66    echo "\n// To observe the 'cannot be doubled' error, you can uncomment the 'ExtendedConfig' class above and run the script.\n";
67}
68
69// 関数を実行し、finalクラスの特性とリフレクションによる判定を確認します。
70checkFinalStatusUsingReflection();

クラスがfinalとして宣言されると、他のクラスから継承できなくなります。これはクラスの設計が完全に固定されており、変更や拡張を許可しない場合に使われます。もしfinalクラスを継承しようとすると、「php is declared final and cannot be doubled」というエラーが発生します。

PHPのリフレクション機能を使うと、プログラム実行中にクラスがfinalであるかを動的に調べることができます。ReflectionObjectクラスは、特定のオブジェクトのクラスに関する詳細情報を提供します。そのgetModifiers()メソッドは、クラスの修飾子（publicやfinalなど）を示すビットマスクを数値として返します。

このサンプルコードでは、ReflectionObject::getModifiers()が返した値とReflectionClass::IS_FINAL定数（final修飾子を表すビット値）をビット論理積（&）で比較し、クラスがfinalであるかを判定しています。リファレンス情報に記載のReflectionObject::IS_FINALはPHP 8では直接存在しませんが、ReflectionObject::getModifiers()はReflectionClassの修飾子情報と同じビットマスクを返すため、ReflectionClass::IS_FINALを利用して判定できます。この定数自体には引数や戻り値はありません。

Copy
1<?php
2
3/**
4 * finalキーワードを持つクラスの例。
5 * このクラスは継承できません。
6 */
7final class FinalClassExample
8{
9    public function getStatus(): string
10    {
11        return "私はfinalクラスです。";
12    }
13}
14
15/**
16 * finalキーワードを持たない通常のクラスの例。
17 * このクラスは継承可能です。
18 */
19class NormalClassExample
20{
21    public function getStatus(): string
22    {
23        return "私は通常のクラスです。";
24    }
25}
26
27/**
28 * 指定されたオブジェクトのクラスがfinalであるかどうかをリフレクションAPIを用いて確認します。
29 *
30 * ReflectionClass::IS_FINAL 定数は、クラスがfinalとして宣言されているかを示すビットマスクです。
31 * ReflectionClass::getModifiers() メソッドが返す値とこの定数を比較することで、
32 * クラスのfinal状態を判定できます。
33 *
34 * @param object $object チェックするオブジェクトのインスタンス。
35 */
36function checkClassFinalStatus(object $object): void
37{
38    // オブジェクトから ReflectionClass インスタンスを作成します。
39    // ReflectionClass はクラス自体の構造や修飾子（finalなど）の情報を取得するために使用されます。
40    $reflectionClass = new ReflectionClass($object);
41
42    // ReflectionClass::getModifiers() は、クラスの修飾子（public, abstract, finalなど）を
43    // ビットマスクとして返します。
44    // その値と ReflectionClass::IS_FINAL 定数をビット論理積で比較することで、
45    // クラスがfinalであるかどうかを判定します。
46    if (($reflectionClass->getModifiers() & ReflectionClass::IS_FINAL) === ReflectionClass::IS_FINAL) {
47        echo "クラス '" . $reflectionClass->getName() . "' は final です。\n";
48    } else {
49        echo "クラス '" . $reflectionClass->getName() . "' は final ではありません。\n";
50    }
51}
52
53// 各クラスのインスタンスを作成します。
54$finalObject = new FinalClassExample();
55$normalObject = new NormalClassExample();
56
57// 作成した関数を呼び出し、各クラスのfinal状態を確認します。
58checkClassFinalStatus($finalObject);
59checkClassFinalStatus($normalObject);
60
61?>

PHPにおけるfinalキーワードは、特定のクラスが他のクラスに継承されることを禁止するために使用されます。これにより、クラスの設計意図を明確にし、予期せぬ変更を防ぐことができます。このサンプルコードでは、finalクラスと通常のクラスの例を通じて、プログラム実行時にクラスがfinalであるかどうかを確認する方法を説明します。

ReflectionClassは、PHPの実行時にクラスの構造や属性（修飾子など）に関する情報を取得するための強力な機能です。ReflectionClass::IS_FINALは、このReflectionClass拡張機能が提供する定数の一つで、特定のクラスがfinalとして宣言されているかを示すビットマスクです。この定数自体に引数はなく、戻り値もありません。

サンプルコード内のcheckClassFinalStatus関数は、引数として受け取ったオブジェクトのクラスがfinalであるかを判定します。まず、渡されたオブジェクトからReflectionClassインスタンスを作成し、getModifiers()メソッドでクラスの修飾子（publicやfinalなど）を示すビットマスク値を取得します。この取得した値とReflectionClass::IS_FINAL定数をビット論理積（&）で比較することで、クラスがfinalかどうかを正確に判定しています。この関数は引数にオブジェクトを取り、判定結果を画面に出力するだけで、特に値を返しません（void）。

例えば、finalキーワードで宣言されたFinalClassExampleのインスタンスに対しては「final です」と出力され、finalキーワードを持たないNormalClassExampleのインスタンスに対しては「final ではありません」と出力されることが確認できます。このように、ReflectionClass::IS_FINAL定数を利用することで、プログラムからクラスの属性を動的に調べることが可能です。