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

Copy
1<?php
2
3/**
4 * Recursively finds all traits used by a class, including traits used by its parent classes
5 * and traits used within other traits.
6 *
7 * @param object|string $class The class name or an object instance.
8 * @return array An array of fully qualified trait names.
9 */
10function class_uses_recursive(object|string $class): array
11{
12    // If an object is passed, get its class name.
13    if (is_object($class)) {
14        $class = get_class($class);
15    }
16
17    $allTraits = [];
18    $currentTraits = [];
19
20    // Collect traits from the current class and all its parent classes.
21    // This loop iterates up the inheritance chain to gather all directly used traits.
22    do {
23        // class_uses returns an array of traits or false if the class doesn't exist.
24        // We use the null coalescing operator (?: []) to ensure we always merge an array.
25        $traitsFromClass = class_uses($class) ?: [];
26        $currentTraits = array_merge($currentTraits, $traitsFromClass);
27        $allTraits = array_merge($allTraits, $traitsFromClass);
28    } while ($class = get_parent_class($class)); // Move to the parent class until no parent is found.
29
30    // Now, recursively collect traits used within the traits that have been gathered.
31    // This loop continues as long as new traits are discovered in the trait dependencies.
32    // $currentTraits holds the traits discovered in the previous "wave" whose sub-traits need to be found.
33    while (!empty($currentTraits)) {
34        $newTraitsDiscovered = [];
35        foreach ($currentTraits as $trait) {
36            // Get traits used by the current trait.
37            $newTraitsDiscovered = array_merge(class_uses($trait) ?: [], $newTraitsDiscovered);
38        }
39        // Identify truly new traits that haven't been processed or added to $allTraits yet.
40        // These new traits will be processed in the next iteration of the while loop.
41        $currentTraits = array_diff($newTraitsDiscovered, $allTraits);
42        // Add these newly discovered traits to the overall collection.
43        $allTraits = array_merge($allTraits, $currentTraits);
44    }
45
46    // Return the unique list of all found traits.
47    // array_unique is used as a final safeguard to ensure no duplicates, although the logic aims to prevent most.
48    return array_unique($allTraits);
49}
50
51// --- Example Usage and Demonstrations ---
52
53// Define some traits for demonstration purposes.
54trait TraitA {
55    use TraitB; // TraitA uses TraitB
56}
57
58trait TraitB {
59    // TraitB does not use any further traits.
60}
61
62trait TraitC {
63    use TraitD; // TraitC uses TraitD
64}
65
66trait TraitD {
67    // TraitD does not use any further traits.
68}
69
70trait TraitE {
71    // TraitE is a standalone trait.
72}
73
74// Define some classes for demonstration purposes.
75class BaseClass {
76    use TraitE; // BaseClass uses TraitE.
77}
78
79class MyClass extends BaseClass {
80    use TraitA; // MyClass uses TraitA.
81    use TraitC; // MyClass uses TraitC.
82}
83
84// Create an instance of MyClass.
85$myObject = new MyClass();
86
87// Get all traits used by MyClass (including those from parent classes and nested traits).
88$allUsedTraits = class_uses_recursive($myObject);
89
90// Sort the results for consistent output in the example.
91sort($allUsedTraits);
92
93echo "All traits used by MyClass (recursively):\n";
94foreach ($allUsedTraits as $traitName) {
95    echo "- " . $traitName . "\n";
96}
97
98echo "\n";
99
100// Demonstrate with a class name directly.
101$baseClassTraits = class_uses_recursive(BaseClass::class);
102sort($baseClassTraits);
103echo "All traits used by BaseClass (recursively):\n";
104foreach ($baseClassTraits as $traitName) {
105    echo "- " . $traitName . "\n";
106}
107
108echo "\n";
109
110// Demonstrate traits used within a trait itself.
111$traitATraits = class_uses_recursive(TraitA::class);
112sort($traitATraits);
113echo "All traits used by TraitA (recursively):\n";
114foreach ($traitATraits as $traitName) {
115    echo "- " . $traitName . "\n";
116}

class_uses_recursive関数は、指定されたクラスまたはオブジェクトが直接的、間接的に使用しているすべてのトレイト名を再帰的に収集し、そのリストを配列として返すカスタム関数です。PHPが標準で提供するclass_uses関数が、クラスが直接使用するトレイトのみを返すのに対し、この関数は、親クラスが使用するトレイトや、別のトレイト内で使用されているネストされたトレイトも網羅的に探索します。

引数としては、調査したい対象のクラス名（文字列）またはそのクラスのオブジェクトインスタンスを渡すことができます。関数内部では、まず指定されたクラスとそのすべての親クラスが直接使用するトレイトを収集します。その後、収集されたトレイト自体がさらに別のトレイトを使用している場合、それらも発見される限り再帰的に追加していきます。戻り値は、発見されたすべてのトレイトの完全修飾名を含む配列となります。

この関数は、複雑なクラス階層やトレイトの利用状況を持つシステムにおいて、あるクラスが最終的にどのような機能群（トレイト）から成り立っているかを網羅的に把握したい場合に非常に有用です。例えば、特定の機能がどのトレイトを通じて提供されているかを追跡する際などに役立ちます。

Copy
1<?php
2
3/**
4 * Trait (トレイト) は、PHPにおいて複数のクラス間でコードを再利用するための仕組みです。
5 * クラスの継承とは異なり、1つのクラスが複数のトレイトを利用できます。
6 */
7trait Timestampable
8{
9    /**
10     * オブジェクトが作成された時刻を返します。
11     */
12    public function getCreatedAt(): DateTime
13    {
14        return new DateTime();
15    }
16}
17
18/**
19 * Timestampable トレイトを利用するクラスを定義します。
20 */
21class User
22{
23    use Timestampable; // Timestampable トレイトのメソッドを User クラスで利用できるようにします。
24
25    private string $name;
26
27    public function __construct(string $name)
28    {
29        $this->name = $name;
30    }
31
32    public function getName(): string
33    {
34        return $this->name;
35    }
36}
37
38/**
39 * トレイトを利用しない別のクラスも定義します。
40 */
41class Product
42{
43    private string $name;
44
45    public function __construct(string $name)
46    {
47        $this->name = $name;
48    }
49
50    public function getName(): string
51    {
52        return $this->name;
53    }
54}
55
56/**
57 * class_uses() 関数は、指定されたクラスまたはオブジェクトが使用している
58 * 全てのトレイトの名前を配列で返します。
59 * トレイトを使用していない場合は空の配列を返します。
60 * クラスが存在しないなどのエラー時には false を返します。
61 */
62
63echo "--- User クラスが使用しているトレイト ---" . PHP_EOL;
64
65// 1. クラス名（文字列）を渡す例
66$userTraits = class_uses(User::class);
67
68if ($userTraits === false) {
69    echo "エラー: User クラスのトレイト取得に失敗しました。" . PHP_EOL;
70} elseif (empty($userTraits)) {
71    echo "User クラスはトレイトを使用していません。" . PHP_EOL;
72} else {
73    echo "User クラスが使用しているトレイト:" . PHP_EOL;
74    foreach ($userTraits as $trait) {
75        echo "- " . $trait . PHP_EOL;
76    }
77}
78echo PHP_EOL;
79
80echo "--- Product クラスのオブジェクトが使用しているトレイト ---" . PHP_EOL;
81
82// 2. オブジェクトを渡す例
83$product = new Product("Laptop");
84$productTraits = class_uses($product);
85
86if ($productTraits === false) {
87    echo "エラー: Product オブジェクトのトレイト取得に失敗しました。" . PHP_EOL;
88} elseif (empty($productTraits)) {
89    echo "Product オブジェクトはトレイトを使用していません。" . PHP_EOL;
90} else {
91    echo "Product オブジェクトが使用しているトレイト:" . PHP_EOL;
92    foreach ($productTraits as $trait) {
93        echo "- " . $trait . PHP_EOL;
94    }
95}
96echo PHP_EOL;
97
98// 動作確認として、トレイトのメソッドが呼び出せることを示します。
99$user = new User("Alice");
100echo "ユーザー名: " . $user->getName() . PHP_EOL;
101echo "作成日時: " . $user->getCreatedAt()->format('Y-m-d H:i:s') . PHP_EOL;
102
103?>

class_uses関数は、指定されたクラスまたはオブジェクトがどのトレイトを使用しているかを調べ、そのトレイト名を配列で返します。トレイトは、PHPでコードを再利用するための仕組みで、useキーワードを使ってクラスに取り込まれます。

引数には、確認したい「クラスの名前（文字列）」か「そのクラスのオブジェクト」を指定します。例えば、TimestampableトレイトをuseしているUserクラスにこの関数を使うと、Timestampableというトレイト名を含む配列が返されます。一方、トレイトをuseしていないProductクラスに使うと、空の配列が戻り値となります。

もし指定したクラスが存在しないなどのエラーが発生した場合は、戻り値としてfalseが返されるため、戻り値がfalseでないか確認し、適切に処理することが大切です。この関数を使うことで、実行時にクラスが利用している機能を動的に把握し、柔軟なコード設計に役立てられます。