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

Copy
1<?php
2
3/**
4 * Base class to demonstrate get_called_class().
5 */
6class BaseClass
7{
8    /**
9     * A static method that returns the name of the class from which it was called.
10     * This uses late static binding.
11     *
12     * @return string The name of the class that invoked this method.
13     */
14    public static function getClassUsedForCall(): string
15    {
16        // get_called_class() returns the name of the class this static method was called on.
17        return get_called_class();
18    }
19}
20
21/**
22 * A derived class that extends BaseClass.
23 */
24class DerivedClass extends BaseClass
25{
26    // No additional methods needed for this demonstration.
27}
28
29// Demonstrate calling the static method directly from the base class.
30echo "Called from BaseClass directly: " . BaseClass::getClassUsedForCall() . PHP_EOL;
31
32// Demonstrate calling the static method from the derived class.
33echo "Called from DerivedClass: " . DerivedClass::getClassUsedForCall() . PHP_EOL;
34
35// It can also be called from an object instance, though it's a static method.
36$obj = new DerivedClass();
37echo "Called from DerivedClass instance: " . $obj::getClassUsedForCall() . PHP_EOL;
38
39?>

PHPのget_called_class関数は、静的メソッドがどのクラスから呼び出されたかを特定するために使用されます。この関数は引数を持ちませんが、呼び出し元のクラス名を文字列として返します。

提供されたサンプルコードでは、BaseClassに定義された静的メソッドgetClassUsedForCallの中でget_called_classが利用されています。このメソッドをBaseClass::getClassUsedForCall()のように直接呼び出すと、get_called_classはBaseClassという文字列を返します。一方、DerivedClassがBaseClassを継承しており、DerivedClass::getClassUsedForCall()のように呼び出すと、get_called_classはDerivedClassという文字列を返します。

これはPHPの「遅延静的束縛（Late Static Binding）」という機能によるもので、メソッドが実際に実行された時点での呼び出し元クラスを正確に取得できるためです。静的メソッドは通常クラス名で呼び出しますが、オブジェクトのインスタンスから呼び出しても、そのインスタンスのクラス名が正しく取得されます。この機能は、共通処理を持つ継承クラス群において、呼び出し元クラスに応じて異なる振る舞いをさせたい場合などに非常に有用です。

Copy
1<?php
2
3/**
4 * プログラミング言語: PHP
5 * 関数名: get_called_class
6 * 説明: このサンプルコードは、get_called_class() 関数がどのように機能するかを示します。
7 *       この関数は、静的メソッドが呼び出された際の「呼び出し元」のクラス名を取得するために使用されます。
8 *       名前空間を使用しないシンプルなケースで、その動作を理解するのに役立ちます。
9 */
10
11/**
12 * 親クラスを定義します。
13 * このクラスは、get_called_class() を使用する静的メソッドを持っています。
14 */
15class Animal
16{
17    /**
18     * この静的メソッドは、現在静的呼び出しが行われているクラスの名前を返します。
19     *
20     * @return string 呼び出し元のクラスの名前
21     */
22    public static function whoAmI()
23    {
24        // get_called_class() は、静的メソッドを「呼び出した」クラスの名前を返します。
25        // これは、メソッドが「定義されている」クラス名 (__CLASS__ など) とは異なる場合があります。
26        return get_called_class();
27    }
28}
29
30/**
31 * Animal クラスを継承する子クラスを定義します。
32 * このクラスは Animal の whoAmI() メソッドを継承します。
33 */
34class Dog extends Animal
35{
36    // Dog クラスは whoAmI() メソッドを直接定義していませんが、親クラスから継承しています。
37}
38
39/**
40 * Animal クラスを継承する別の子クラスを定義します。
41 */
42class Cat extends Animal
43{
44    // Cat クラスも whoAmI() メソッドを継承しています。
45}
46
47// --- get_called_class() の動作確認 ---
48
49// Animal クラスから直接静的メソッドを呼び出す場合
50// この場合、呼び出し元もメソッドの定義元も Animal なので "Animal" が返されます。
51echo "Animal::whoAmI() の結果: " . Animal::whoAmI() . PHP_EOL;
52
53// Dog クラスから静的メソッドを呼び出す場合
54// whoAmI() メソッド自体は Animal クラスで定義されていますが、
55// 実際に呼び出しを行ったのは Dog クラスなので "Dog" が返されます。
56echo "Dog::whoAmI() の結果: " . Dog::whoAmI() . PHP_EOL;
57
58// Cat クラスから静的メソッドを呼び出す場合
59// 同様に、呼び出しを行ったのは Cat クラスなので "Cat" が返されます。
60echo "Cat::whoAmI() の結果: " . Cat::whoAmI() . PHP_EOL;
61
62// 実行結果は、get_called_class() がメソッドの「定義元」ではなく、
63// メソッドの「呼び出し元」のクラス名を正確に返すことを示しています。
64// このサンプルは、名前空間を使用しないシンプルな状況での動作を示しています。
65

PHPのget_called_class()関数は、静的メソッドが呼び出された際に、実際にそのメソッドを「呼び出した」クラスの名前（文字列）を取得するために使用されます。この関数は引数を一切取らず、常に呼び出し元のクラス名を文字列として返します。

通常のクラスメソッド内では、__CLASS__マジック定数を使うとメソッドが「定義されている」クラス名を取得できますが、get_called_class()はメソッドが継承され、子クラスから静的に呼び出された場合など、「実際に呼び出しが行われた」クラスの名前を正確に特定する点で異なります。

提供されたサンプルコードでは、Animalクラスに静的メソッドwhoAmI()が定義されており、この中でget_called_class()が使われています。DogクラスとCatクラスはAnimalクラスを継承しています。

Animal::whoAmI()を呼び出すと、メソッドの定義元も呼び出し元もAnimalなので「Animal」と返されます。しかし、Dog::whoAmI()を呼び出すと、whoAmI()メソッド自体はAnimalに定義されていますが、実際に呼び出したのはDogクラスであるため「Dog」と返されます。同様に、Cat::whoAmI()は「Cat」を返します。

このように、get_called_class()は、継承関係にあるクラスから静的メソッドを呼び出す際に、現在どのクラスのコンテキストで実行されているかを判断するのに非常に役立ちます。このサンプルは、名前空間を使用しないシンプルなケースで、その基本的な動作を明確に示しています。

Copy
1<?php
2
3class BaseClass {
4    public static function whoCalled() {
5        // 呼び出し元のクラス名を取得
6        $className = get_called_class();
7        echo "呼び出したクラス: " . $className . PHP_EOL;
8    }
9}
10
11class SubClass extends BaseClass {
12    public static function test() {
13        parent::whoCalled();
14    }
15}
16
17// BaseClass から呼び出す
18BaseClass::whoCalled();
19
20// SubClass から呼び出す
21SubClass::test();
22
23?>

このPHPサンプルコードは、get_called_class()関数を使用して、静的メソッドを呼び出したクラス名を取得する方法を示しています。get_called_class()関数は引数を取らず、呼び出したクラスの名前を文字列として返します。この関数は、静的メソッドまたは遅延静的束縛（late static binding）で使用される場合に特に役立ちます。

BaseClassという基底クラスには、whoCalled()という静的メソッドが定義されています。このメソッド内でget_called_class()関数を呼び出すことで、そのメソッドを呼び出したクラスの名前を取得し、出力しています。SubClassはBaseClassを継承しており、test()メソッド内でparent::whoCalled()を呼び出すことで、基底クラスのwhoCalled()メソッドを呼び出しています。

サンプルコードを実行すると、まずBaseClass::whoCalled()が直接呼び出されるため、「呼び出したクラス: BaseClass」と出力されます。次に、SubClass::test()が呼び出され、その中でparent::whoCalled()が呼び出されるため、「呼び出したクラス: SubClass」と出力されます。

このように、get_called_class()関数は、継承関係にあるクラス間で、どのクラスからメソッドが呼び出されたかを特定する際に役立ちます。特に、親クラスで定義されたメソッドが、子クラスによってオーバーライドされる場合に、その振る舞いを制御するために利用できます。