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

Copy
1<?php
2
3/**
4 * このスクリプトは、クラスのインスタンスからクラス名を取得し、
5 * そのクラスが定義している定数をすべて取得して表示する方法を示します。
6 * システムエンジニアを目指す初心者向けに、簡潔で分かりやすい例です。
7 */
8
9/**
10 * サンプルとなるクラスを定義します。
11 * クラス定数がいくつか定義されています。
12 */
13class Product
14{
15    // 製品の状態を表す定数
16    public const STATUS_ACTIVE = 'active';
17    public const STATUS_INACTIVE = 'inactive';
18    public const STATUS_ARCHIVED = 'archived';
19
20    // デフォルトの通貨
21    public const DEFAULT_CURRENCY = 'USD';
22
23    // プロパティ
24    private string $name;
25    private string $status;
26
27    public function __construct(string $name, string $status = self::STATUS_ACTIVE)
28    {
29        $this->name = $name;
30        $this->status = $status;
31    }
32
33    public function getName(): string
34    {
35        return $this->name;
36    }
37
38    public function getStatus(): string
39    {
40        return $this->status;
41    }
42}
43
44/**
45 * Productクラスのインスタンスを作成します。
46 */
47$myProduct = new Product('Laptop', Product::STATUS_ACTIVE);
48
49/**
50 * get_class()関数を使用して、オブジェクトのクラス名を取得します。
51 * これは、提供されたリファレンス情報に記載されている関数です。
52 */
53$className = get_class($myProduct);
54
55echo "取得されたクラス名: " . $className . "\n\n";
56
57/**
58 * 取得したクラス名（文字列）を使用して、ReflectionClassをインスタンス化します。
59 * ReflectionClassは、クラスに関する詳細な情報を取得するためのPHPの組み込みクラスです。
60 */
61$reflector = new ReflectionClass($className);
62
63/**
64 * getConstants()メソッドを使用して、クラスに定義されているすべての定数を取得します。
65 * これにより、クラス定数とその値が連想配列として返されます。
66 */
67$classConstants = $reflector->getConstants();
68
69echo "クラス定数:\n";
70print_r($classConstants);
71
72?>

このサンプルコードは、PHPでオブジェクトからそのクラス名を取得し、さらにそのクラスが定義している定数をすべて動的に取得して表示する方法を示すものです。

get_class関数は、指定されたオブジェクトがどのクラスに属しているかを知るために使われます。引数には?object $object = nullを取り、オブジェクトを渡すとそのクラス名を文字列として返します。もし引数を省略するかnullを指定した場合（クラスのメソッド内で呼び出した場合など）は、現在のスコープのクラス名を返します。戻り値は常にstring型で、クラス名が文字列として提供されます。

このコードでは、まずProductというクラスを定義し、いくつかのクラス定数を設定しています。次に、$myProductというProductクラスのインスタンスを作成します。

その後、get_class($myProduct)を実行することで、$myProductがProductクラスのインスタンスであるため、"Product"というクラス名が文字列として取得され、変数$classNameに格納されます。

さらに、取得したクラス名（"Product"）を使ってReflectionClassのインスタンスを生成します。ReflectionClassは、実行時にクラスの構造に関する詳細な情報を取得するためのPHPの組み込みクラスです。$reflectorオブジェクトのgetConstants()メソッドを呼び出すと、Productクラスに定義されているすべての定数とその値が連想配列として取得され、print_r関数によって出力されます。これにより、プログラムの実行中にクラスの定義情報を動的に調べることが可能になります。

Copy
1<?php
2
3/**
4 * get_class() 関数を使用して、現在のクラスの名前を取得するサンプルコードです。
5 *
6 * get_class() を引数なしで呼び出すと、その関数が呼び出されたスコープのクラス名が返されます。
7 * これは、現在のメソッドがどのクラスに属しているかを知りたい場合に便利です。
8 */
9class ExampleClass
10{
11    /**
12     * このメソッドが所属するクラスの名前を取得して返します。
13     *
14     * @return string 現在のクラス名
15     */
16    public function getCurrentClassName(): string
17    {
18        // get_class() を引数なしで呼び出すと、このメソッドが属するクラスの名前を返します。
19        return get_class();
20    }
21}
22
23// ExampleClass のインスタンスを作成します。
24$instance = new ExampleClass();
25
26// インスタンスのメソッドを呼び出し、現在のクラス名を取得して出力します。
27echo "取得されたクラス名: " . $instance->getCurrentClassName() . PHP_EOL;
28
29// 参考: オブジェクトを引数として渡した場合、そのオブジェクトのクラス名が取得されます。
30// echo "オブジェクトのクラス名: " . get_class($instance) . PHP_EOL;
31
32?>

get_class関数は、指定されたオブジェクトのクラス名、または引数を省略した場合は現在のスコープのクラス名を取得するために使用するPHPの内部関数です。

この関数は、?object $object = nullという引数を持ち、常にstring型のクラス名を返します。引数$objectはオプションで、オブジェクトを渡さない場合はnullがデフォルト値として扱われます。

サンプルコードでは、ExampleClassというクラス内に定義されたgetCurrentClassNameメソッドから、引数なしでget_class()を呼び出しています。このように引数を省略して呼び出すと、その関数が実行されている「現在のクラス」の名前、つまりExampleClassという文字列が戻り値として返されます。これにより、メソッド自身がどのクラスに属しているのかを簡単に確認できます。

一方、もしget_class()にオブジェクトのインスタンス、例えばget_class($instance)のように$instanceを引数として渡した場合は、そのインスタンスが属するクラス名（この場合はやはりExampleClass）が返されます。この機能は、特定のオブジェクトのクラス情報を動的に知りたい場合に役立ちます。どちらの場合も、戻り値は常にクラス名を文字列で表現したものです。

Copy
1<?php
2
3/**
4 * サンプルクラスを定義します。
5 */
6class Product
7{
8    /**
9     * @var string 商品名
10     */
11    public $name = 'Default Product';
12
13    /**
14     * @var float 商品価格
15     */
16    protected $price = 0.0; // protected プロパティは get_class_vars に含まれません
17
18    /**
19     * @var int 商品ID
20     */
21    private $id = 1; // private プロパティも get_class_vars に含まれません
22
23    /**
24     * @var string 商品コード (静的プロパティも get_class_vars には含まれません)
25     */
26    public static $code = 'PROD001';
27
28    /**
29     * コンストラクタ
30     *
31     * @param string $name
32     * @param float $price
33     */
34    public function __construct(string $name, float $price)
35    {
36        $this->name = $name;
37        $this->price = $price;
38    }
39}
40
41/**
42 * Product クラスのインスタンスを作成します。
43 */
44$product = new Product('Laptop', 1200.00);
45
46/**
47 * オブジェクトからクラス名を取得します。
48 * get_class 関数は、指定されたオブジェクトのクラス名を文字列で返します。
49 */
50$className = get_class($product);
51echo "オブジェクトのクラス名: " . $className . PHP_EOL;
52
53/**
54 * 取得したクラス名を使用して、そのクラスのデフォルトの公開プロパティを取得します。
55 * get_class_vars 関数は、指定されたクラスのデフォルトの公開プロパティを連想配列として返します。
56 * protected および private プロパティ、静的プロパティは含まれません。
57 */
58$classVars = get_class_vars($className);
59
60echo "クラス '" . $className . "' のデフォルトプロパティ:" . PHP_EOL;
61foreach ($classVars as $varName => $defaultValue) {
62    echo "- " . $varName . ": " . $defaultValue . PHP_EOL;
63}
64
65// get_class_vars はオブジェクトを直接引数に取ることもできます
66// $classVarsFromObject = get_class_vars($product);
67// var_dump($classVarsFromObject);
68
69?>

PHPでは、クラスから作成された「オブジェクト」を操作します。get_class関数は、指定されたオブジェクトがどのクラスから作られたものか、そのクラス名を文字列として取得するために使用されます。引数にはクラス名を知りたいオブジェクトを渡します。戻り値はクラス名を表す文字列です。この機能により、プログラムの実行中にオブジェクトの型を動的に確認できます。

一方、get_class_vars関数は、指定されたクラスが持つ「公開（public）」アクセス可能なプロパティの定義情報とそのデフォルト値を連想配列として取得します。この関数にクラス名（文字列）またはオブジェクトを渡すと、そのクラスに定義されている公開プロパティ名と、初期値が設定されていればその値が返されます。ただし、アクセス修飾子がprotectedやprivateのプロパティ、あるいはstaticなプロパティは対象外となり、取得できません。主に、クラスの公開プロパティの構造を調べたい場合に利用されます。

サンプルコードでは、まずProductクラスのオブジェクトを作成し、get_class関数でそのクラス名を取得しています。次に、取得したクラス名をget_class_vars関数に渡し、Productクラスの公開プロパティであるnameのデフォルト値を取得・表示しています。このように、両関数を組み合わせることで、オブジェクトやクラスの情報を動的に探ることができます。