【PHP8.x】class_parents関数の使い方
class_parents関数の使い方について、初心者にもわかりやすく解説します。
基本的な使い方
class_parents関数は、指定されたクラスが継承しているすべての親クラスの名前を取得する関数です。PHPのオブジェクト指向プログラミングにおいて、クラスは他のクラスの機能や特性を受け継ぐ「継承」という仕組みを利用します。この関数は、あるクラスがどのような親クラスから機能を受け継いでいるのか、その継承の経路をプログラムで確認したい場合に非常に有効です。
この関数にクラスの名前（文字列）またはそのクラスのオブジェクトを渡すと、親クラスの名前を文字列として格納した配列を返します。返される配列の順序は、指定されたクラスに最も近い親クラスから始まり、さらにその親クラスへと、継承の階層を遡る形で並べられます。例えば、CクラスがBクラスを継承し、BクラスがAクラスを継承している場合、Cクラスに対してこの関数を適用すると、['B', 'A']のような配列が返されます。
もし、指定されたクラスがどのクラスも継承していない（つまり、親クラスを持たない）場合は、空の配列を返します。また、存在しないクラス名を指定した場合には、falseを返して、クラスが見つからなかったことを通知します。クラスの継承関係を動的に分析したり、特定のクラスが特定の親クラスを持っているかを確認したりする際に役立つでしょう。
構文(syntax)
1<?php 2 3class GrandparentClass {} 4class ParentClass extends GrandparentClass {} 5class ChildClass extends ParentClass {} 6 7// クラス名を文字列で指定して、その親クラスをすべて取得 8$parents = class_parents('ChildClass'); 9 10// 結果は親クラスの名前を要素とする配列 11print_r($parents); 12 13// オブジェクトのインスタンスを指定して、その親クラスをすべて取得 14$childObject = new ChildClass(); 15$objectParents = class_parents($childObject); 16 17print_r($objectParents); 18 19?>
引数(parameters)
object|string $object_or_class, bool $autoload = true
- object|string $object_or_class: 親クラスの情報を取得したいオブジェクト、またはクラス名を表す文字列
- bool $autoload = true: オートロードを有効にするかどうかを指定する真偽値（デフォルトは true）
戻り値(return)
array|false
指定されたクラスの親クラスの名前を配列で返します。クラスが存在しない場合は false を返します。
サンプルコード
PHP class_parents で親クラスを取得する
1<?php 2 3/** 4 * 基本的な乗り物を表すクラス。 5 */ 6class Vehicle 7{ 8 // このクラスは継承の例のために定義されています。 9 // 特に追加するプロパティやメソッドはありません。 10} 11 12/** 13 * 車を表すクラス。Vehicleを継承します。 14 */ 15class Car extends Vehicle 16{ 17 // Carクラス独自のプロパティやメソッドをここに追加できます。 18} 19 20/** 21 * スポーツカーを表すクラス。Carを継承します。 22 */ 23class SportsCar extends Car 24{ 25 // SportsCarクラス独自のプロパティやメソッドをここに追加できます。 26} 27 28echo "--- class_parents() の使用例 ---\n\n"; 29 30// 1. クラス名（文字列）を引数として渡す例 31// 'SportsCar' クラスが直接または間接的に継承している全ての親クラスを取得します。 32echo "1. 'SportsCar' クラスの親クラス:\n"; 33$parentsOfSportsCar = class_parents('SportsCar'); 34 35if ($parentsOfSportsCar !== false) { 36 print_r($parentsOfSportsCar); 37} else { 38 echo "親クラスが見つかりませんでした。\n"; 39} 40echo "\n"; 41 42// 2. オブジェクトを引数として渡す例 43// 'SportsCar' クラスのインスタンスを作成し、そのオブジェクトの親クラスを取得します。 44echo "2. 'SportsCar' オブジェクトの親クラス:\n"; 45$mySportsCar = new SportsCar(); 46$parentsOfObject = class_parents($mySportsCar); 47 48if ($parentsOfObject !== false) { 49 print_r($parentsOfObject); 50} else { 51 echo "親クラスが見つかりませんでした。\n"; 52} 53echo "\n"; 54 55// 3. 別のクラスの例 56// 'Car' クラスの親クラスを取得します。 57echo "3. 'Car' クラスの親クラス:\n"; 58$parentsOfCar = class_parents('Car'); 59 60if ($parentsOfCar !== false) { 61 print_r($parentsOfCar); 62} else { 63 echo "親クラスが見つかりませんでした。\n"; 64} 65echo "\n"; 66 67// 結果の配列は、継承の深さに応じて上位のクラスから順に並びます。 68// 例えば SportsCar の場合、Car (直接の親) -> Vehicle (Carの親) の順になります。 69 70?>
PHPのclass_parents関数は、指定されたクラスやオブジェクトが直接的または間接的に継承している全ての親クラスのリストを取得するために使用します。この関数は、オブジェクト指向プログラミングにおけるクラスの継承関係を動的に調査する際に役立ちます。
引数には、親クラスを知りたいクラスの名前を文字列で渡すか、そのクラスのインスタンス（オブジェクト）を渡すことができます。オプションの第二引数$autoloadは、指定されたクラスが見つからない場合にPHPのオートロード機能を呼び出すかどうかを制御します。通常はtrueのままで問題ありません。
戻り値としては、継承の深さに応じて最も近い親クラスから順に、親クラスの名前が格納された配列が返されます。もし指定されたクラスに親クラスが存在しない場合や、クラスが見つからない場合はfalseが返されます。
サンプルコードでは、Vehicle、Car、SportsCarという継承関係を持つクラスを定義しています。class_parents関数を使い、'SportsCar'というクラス名を文字列として指定した場合と、new SportsCar()で作成したオブジェクトを指定した場合の両方で親クラスのリストを取得しています。これにより、SportsCarの親であるCarと、さらにその親であるVehicleが配列として取得される様子を確認できます。また、'Car'クラスの親クラスを取得する例も示されており、Carの親であるVehicleのみが返されることがわかります。このように、class_parents関数はクラスの継承チェーンを簡単にたどるための便利な機能です。
class_parents関数は、指定されたクラスやオブジェクトが直接的または間接的に継承している全ての親クラス名を配列で取得します。引数には、クラスのインスタンス（オブジェクト）またはクラス名（文字列）のどちらかを渡すことができます。親クラスが存在しない場合や、指定したクラスが見つからない場合はfalseを返しますので、必ず戻り値がfalseでないか確認してください。戻り値の配列は、最も直接的な親クラスから順に、上位の親クラスへと並びます。これにより、継承の階層を把握することができます。この関数は、クラスの継承関係を動的に調べたい場合に役立ちます。