【PHP8.x】get_declared_classes関数の使い方

Copy
1<?php
2
3/**
4 * サンプルクラスA
5 */
6class MyClassA
7{
8    public function __construct()
9    {
10        // コンストラクタ
11    }
12}
13
14/**
15 * サンプルクラスB
16 */
17class MyClassB
18{
19    public static function someStaticMethod(): void
20    {
21        // 静的メソッド
22    }
23}
24
25// get_declared_classes() は、スクリプト実行中に定義されている全てのクラス名を配列で返します。
26// これには、ユーザー定義クラスだけでなく、PHP の内部クラスも含まれます。
27$declaredClasses = get_declared_classes();
28
29echo "現在定義されているクラス一覧:\n";
30echo "---------------------------------\n";
31
32// 見やすくするために、定義したばかりのユーザー定義クラスに絞って表示することもできますが、
33// ここでは関数が返す全てのクラスを表示します。
34foreach ($declaredClasses as $className) {
35    echo $className . "\n";
36}
37
38echo "---------------------------------\n";
39echo "上記リストには、ユーザー定義クラス (MyClassA, MyClassB など) と、\n";
40echo "PHP が提供する内部クラス (StdClass, Exception など) の両方が含まれます。\n";
41
42?>

PHP 8.4のget_declared_classes関数は、現在スクリプトの実行中にPHP環境内で利用可能なすべてのクラスの名前を、文字列の配列として取得する際に使用します。この関数は引数を一切受け付けず、戻り値として宣言済みのクラス名が格納された配列（array）を返します。

サンプルコードでは、MyClassAとMyClassBという2つのカスタムクラスを事前に定義しています。その後、get_declared_classes()関数を呼び出すことで、これらのユーザー定義クラスに加え、StdClassやExceptionといったPHPが内部的に提供する様々な組み込みクラスの名前もすべて網羅した配列が$declaredClasses変数に格納されます。この配列をループ処理で表示することにより、PHP環境が認識しているクラスの一覧を動的に確認できます。これにより、スクリプト実行時にどのようなクラスが存在しているかを把握し、プログラムの振る舞いを理解するのに役立ちます。

Copy
1<?php
2
3/**
4 * サンプルクラスAを定義します。
5 */
6class SampleClassA
7{
8    public function __construct()
9    {
10        // コンストラクタ
11    }
12}
13
14/**
15 * サンプルクラスBを定義します。
16 */
17class SampleClassB
18{
19    public static function staticMethod()
20    {
21        return "Static method called.";
22    }
23}
24
25/**
26 * PHPスクリプト内で宣言されているすべてのクラス名を取得し、表示します。
27 * get_declared_classes() は、スクリプト実行時までに定義されているクラス（
28 * PHP組み込みクラス、ユーザー定義クラス、ロードされたライブラリのクラスなど）
29 * の名前を配列として返します。
30 */
31function displayDeclaredClasses(): void
32{
33    echo "--- 宣言されているクラス一覧 ---\n";
34
35    // 宣言されているクラスの配列を取得
36    $declaredClasses = get_declared_classes();
37
38    // クラス名をアルファベット順にソートすると見やすくなります
39    sort($declaredClasses);
40
41    foreach ($declaredClasses as $className) {
42        echo "- " . $className . "\n";
43    }
44
45    echo "--- 表示終了 ---\n";
46}
47
48// 関数を実行して、宣言されているクラスを表示
49displayDeclaredClasses();
50
51?>

PHPのget_declared_classes関数は、PHPスクリプトが実行された時点で、現在までに宣言されているすべてのクラスの名前を取得するための内部関数です。この関数は引数をとりません。戻り値は配列（array）であり、その配列には宣言されているクラス名が文字列として格納されます。

取得されるクラス名には、サンプルコードで定義されているSampleClassAやSampleClassBのようなユーザー定義クラスに加え、PHPが標準で提供する組み込みクラスや、スクリプト内でロードされたライブラリのクラスも含まれます。

サンプルコードでは、SampleClassAとSampleClassBという2つのユーザー定義クラスを宣言した後、displayDeclaredClasses関数内でget_declared_classes()を呼び出しています。この呼び出しにより、それまでに宣言されたすべてのクラス名が配列として取得されます。取得したクラス名の配列はアルファベット順にソートされ、その後foreachループを使って各クラス名が画面に出力されます。この関数は、実行中のPHP環境でどのようなクラスが利用可能であるかを動的に確認したり、特定のクラスの存在を検証したりするデバッグなどの場面で役立ちます。

Copy
1<?php
2
3namespace App\Models {
4    class User
5    {
6        public function __construct()
7        {
8            // Constructor logic
9        }
10    }
11
12    class Product
13    {
14        public function __construct()
15        {
16            // Constructor logic
17        }
18    }
19}
20
21namespace App\Services {
22    class AuthService
23    {
24        public function __construct()
25        {
26            // Constructor logic
27        }
28    }
29}
30
31namespace App\Utils {
32    class Helper
33    {
34        public function __construct()
35        {
36            // Constructor logic
37        }
38    }
39}
40
41// Global scope class
42class GlobalClass
43{
44    public function __construct()
45    {
46        // Constructor logic
47    }
48}
49
50/**
51 * 特定のネームスペースに属する宣言済みクラスを検索し、表示する関数です。
52 *
53 * @param string $namespaceName 検索対象のネームスペース名 (例: 'App\Models')
54 * @return void
55 */
56function findClassesInNamespace(string $namespaceName): void
57{
58    // 全ての宣言済みクラスを取得
59    $allDeclaredClasses = get_declared_classes();
60    $foundClasses = [];
61
62    echo "=== ネームスペース '{$namespaceName}' 内のクラス検索 ===\n";
63
64    foreach ($allDeclaredClasses as $className) {
65        // クラス名が指定されたネームスペースで始まるかチェック
66        // ネームスペース名の後にバックスラッシュがあることを確認することで、
67        // 'App\Model' と 'App\Models' のような誤判定を防ぐ
68        if (str_starts_with($className, $namespaceName . '\\')) {
69            $foundClasses[] = $className;
70        }
71    }
72
73    if (empty($foundClasses)) {
74        echo "指定されたネームスペース内でクラスは見つかりませんでした。\n";
75    } else {
76        echo "見つかったクラス:\n";
77        foreach ($foundClasses as $class) {
78            echo "- {$class}\n";
79        }
80    }
81    echo "\n";
82}
83
84// 例として、異なるネームスペースで関数を実行
85findClassesInNamespace('App\Models');
86findClassesInNamespace('App\Services');
87findClassesInNamespace('App\Utils');
88findClassesInNamespace('NonExistent\Namespace');
89
90?>

PHPのget_declared_classes関数は、現在スクリプトが読み込んで認識している全てのクラス名を、文字列の配列として取得する組み込み関数です。この関数は引数を一切必要とせず、宣言されているクラス名のリストを返します。

提供されたサンプルコードは、このget_declared_classes関数を使って、特定のネームスペースに属するクラスだけを抽出する方法を示しています。コードでは、App\ModelsやApp\Servicesといった異なるネームスペース内に複数のクラスが定義されています。findClassesInNamespaceという関数は、まずget_declared_classes()を呼び出し、これら全ての宣言済みクラスの名前を一覧として取得します。その後、取得したクラス名のリストを一つずつ確認し、引数で渡されたネームスペース名でクラス名が始まるかどうかをstr_starts_with関数で判定します。この際、ネームスペース名の後にバックスラッシュを加えることで、例えば「App\Model」と「App\Models」のように似た名前のネームスペースを正確に区別し、目的のネームスペースに属するクラスだけを確実に特定しています。最終的に、指定されたネームスペース内で見つかったクラス名が表示され、アプリケーション内のクラス管理に役立てることができます。