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

Copy
1<?php
2
3/**
4 * このスクリプトは、ReflectionMethod::inNamespace() メソッドの使用例を示します。
5 * メソッドが名前空間内で定義されているかどうかを判定します。
6 */
7
8// 名前空間内で定義されたクラスとメソッドの例
9namespace MyApp\Utility {
10    class StringHelper
11    {
12        public function capitalize(string $text): string
13        {
14            return ucfirst($text);
15        }
16    }
17}
18
19// グローバル名前空間で定義されたクラスとメソッドの例
20class GlobalHelper
21{
22    public function greet(): string
23    {
24        return "Hello from global namespace!";
25    }
26}
27
28echo "--- ReflectionMethod::inNamespace() の使用例 ---" . PHP_EOL;
29
30// 1. 名前空間内のメソッドをリフレクション
31try {
32    // ReflectionMethod オブジェクトを作成
33    $reflectionMethodInNamespace = new ReflectionMethod(\MyApp\Utility\StringHelper::class, 'capitalize');
34
35    // inNamespace() メソッドを呼び出し、結果を出力
36    // メソッドが名前空間内で定義されているため、true を返すはず
37    echo "メソッド '" . $reflectionMethodInNamespace->getName() . "' (クラス: " . $reflectionMethodInNamespace->getDeclaringClass()->getName() . ") は名前空間内にあるか？: ";
38    echo ($reflectionMethodInNamespace->inNamespace() ? 'はい' : 'いいえ') . PHP_EOL;
39} catch (ReflectionException $e) {
40    echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
41}
42
43echo PHP_EOL; // 見やすくするための改行
44
45// 2. グローバル名前空間のメソッドをリフレクション
46try {
47    // ReflectionMethod オブジェクトを作成
48    $reflectionMethodInGlobal = new ReflectionMethod(GlobalHelper::class, 'greet');
49
50    // inNamespace() メソッドを呼び出し、結果を出力
51    // メソッドがグローバル名前空間で定義されているため、false を返すはず
52    echo "メソッド '" . $reflectionMethodInGlobal->getName() . "' (クラス: " . $reflectionMethodInGlobal->getDeclaringClass()->getName() . ") は名前空間内にあるか？: ";
53    echo ($reflectionMethodInGlobal->inNamespace() ? 'はい' : 'いいえ') . PHP_EOL;
54} catch (ReflectionException $e) {
55    echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
56}
57
58echo PHP_EOL;
59echo "--- 実行終了 ---" . PHP_EOL;
60

PHPのReflectionMethod::inNamespace()メソッドは、特定のクラスメソッドがPHPの名前空間内で定義されているかどうかを判定するために使用されます。このメソッドは、プログラムの実行中にクラスやメソッドの情報を動的に取得・操作できる「リフレクションAPI」の一部です。

inNamespace()メソッドは引数を一切取りません。メソッドがnamespaceキーワードで定義された名前空間の内部に存在する場合にtrueを、名前空間を明示的に指定しないグローバル名前空間に存在する場合にfalseをブール値で返します。

サンプルコードでは、まずMyApp\Utility名前空間内に定義されたStringHelperクラスのcapitalizeメソッドをReflectionMethodオブジェクトとして取得します。このオブジェクトに対してinNamespace()を呼び出すと、メソッドが名前空間内に属しているため結果はtrueとなります。

次に、名前空間を明示しないグローバル名前空間で定義されたGlobalHelperクラスのgreetメソッドを同様にリフレクションします。この場合、inNamespace()はfalseを返し、メソッドがグローバル名前空間に属していることを正確に示します。

この機能は、実行時にコードの構造を解析し、メソッドの定義場所に基づいて動的に処理を分岐させる際などに活用できます。

Copy
1<?php
2
3/**
4 * 名前空間内に定義されたクラスとメソッドの例
5 */
6namespace MyNamespace {
7    class MyClass
8    {
9        /**
10         * このメソッドは名前空間 'MyNamespace' 内に定義されています。
11         */
12        public function myMethod(): string
13        {
14            return "This is myMethod in MyNamespace\\MyClass.";
15        }
16    }
17}
18
19/**
20 * グローバル名前空間に定義されたクラスとメソッドの例
21 */
22class GlobalClass
23{
24    /**
25     * このメソッドはグローバル名前空間に定義されています。
26     */
27    public function globalMethod(): string
28    {
29        return "This is globalMethod in GlobalClass.";
30    }
31}
32
33// ReflectionMethod を使用して、それぞれのメソッドが名前空間内に存在するかを判定します。
34
35// 1. 名前空間内のメソッドの情報を取得し、inNamespace() を呼び出す
36$reflectionMethodInNamespace = new ReflectionMethod(\MyNamespace\MyClass::class, 'myMethod');
37echo "--- メソッド: " . $reflectionMethodInNamespace->getName() . " ---\n";
38echo "完全なクラス名: " . $reflectionMethodInNamespace->getDeclaringClass()->getName() . "\n";
39// inNamespace() メソッドは、このメソッドが名前空間内に定義されたクラスに属するかどうかを判定します。
40echo "名前空間内にありますか？: " . ($reflectionMethodInNamespace->inNamespace() ? 'はい' : 'いいえ') . "\n\n";
41
42// 2. グローバル名前空間のメソッドの情報を取得し、inNamespace() を呼び出す
43$reflectionMethodGlobal = new ReflectionMethod(GlobalClass::class, 'globalMethod');
44echo "--- メソッド: " . $reflectionMethodGlobal->getName() . " ---\n";
45echo "完全なクラス名: " . $reflectionMethodGlobal->getDeclaringClass()->getName() . "\n";
46// inNamespace() メソッドは、このメソッドが名前空間内に定義されたクラスに属するかどうかを判定します。
47echo "名前空間内にありますか？: " . ($reflectionMethodGlobal->inNamespace() ? 'はい' : 'いいえ') . "\n";

PHPのReflectionMethod::inNamespaceメソッドは、実行時に特定のメソッドが名前空間内に定義されたクラスに属しているかどうかを判定するための機能です。ReflectionMethodクラスは、プログラムの構造、特にクラスやメソッドに関する情報を動的に調べ、操作することを可能にします。

このinNamespaceメソッドは引数を一切取らず、戻り値として真偽値（bool）を返します。もし対象のメソッドが名前空間内に定義されたクラスに属していればtrueを、そうではなくグローバル名前空間（名前空間が指定されていないPHPファイルの最上位レベル）に属していればfalseを返します。名前空間とは、コードの衝突を防ぎ、関連するクラスや関数を論理的にグループ化するための仕組みです。

サンプルコードでは、まずMyNamespaceという名前空間内に定義されたMyClass::myMethodと、グローバル名前空間に定義されたGlobalClass::globalMethodという二つのメソッドを準備しています。それぞれのメソッドについてReflectionMethodのインスタンスを作成し、inNamespaceメソッドを呼び出しています。

結果として、MyNamespace\MyClass::myMethodに対してinNamespace()を呼び出すと、名前空間内に存在するためtrueが返され、「はい」と表示されます。これに対し、GlobalClass::globalMethodに対してはグローバル名前空間に属しているためfalseが返され、「いいえ」と表示されます。このように、inNamespaceメソッドを使うことで、プログラムから動的にメソッドの定義場所を確認することが可能です。