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

<?php

/**
 * このファイルは、`get_parent_class` 関数を使って、
 * クラスの親クラス名を取得する方法を示すサンプルコードです。
 *
 * `get_parent_class` 関数は、オブジェクトまたはクラス名の文字列を引数に取り、
 * そのクラスの親クラスの名前を文字列で返します。
 * 親クラスが存在しない場合は `false` を返します。
 */

// 親クラスを定義します
class MyBaseClass
{
    // ...
}

// MyBaseClass を継承する子クラスを定義します
class MyDerivedClass extends MyBaseClass
{
    // ...
}

// どのクラスも継承しない独立したクラスを定義します
class MyStandaloneClass
{
    // ...
}

// 例1: オブジェクトから親クラス名を取得する
$derivedObject = new MyDerivedClass();
$parentOfObject = get_parent_class($derivedObject);

if ($parentOfObject !== false) {
    echo "オブジェクト '" . get_class($derivedObject) . "' の親クラス: " . $parentOfObject . PHP_EOL;
} else {
    echo "オブジェクト '" . get_class($derivedObject) . "' に親クラスはありません。" . PHP_EOL;
}

echo PHP_EOL; // 出力を区切るための改行

// 例2: クラス名の文字列から親クラス名を取得する
$parentOfClassName = get_parent_class('MyDerivedClass');

if ($parentOfClassName !== false) {
    echo "クラス名 'MyDerivedClass' の親クラス: " . $parentOfClassName . PHP_EOL;
} else {
    echo "クラス名 'MyDerivedClass' に親クラスはありません。" . PHP_EOL;
}

echo PHP_EOL; // 出力を区切るための改行

// 例3: 親クラスを持たないクラスの場合 (`false` が返される)
$parentOfStandalone = get_parent_class('MyStandaloneClass');

if ($parentOfStandalone === false) {
    echo "クラス名 'MyStandaloneClass' の親クラス: false (親クラスが存在しないため)" . PHP_EOL;
} else {
    echo "クラス名 'MyStandaloneClass' の親クラス: " . $parentOfStandalone . PHP_EOL;
}

echo PHP_EOL; // 出力を区切るための改行

// 例4: 存在しないクラス名を指定した場合 (`false` が返される)
$parentOfNonExistent = get_parent_class('NonExistentClass');

if ($parentOfNonExistent === false) {
    echo "クラス名 'NonExistentClass' の親クラス: false (クラスが存在しないため)" . PHP_EOL;
} else {
    echo "クラス名 'NonExistentClass' の親クラス: " . $parentOfNonExistent . PHP_EOL;
}

?>

PHPのget_parent_class関数は、指定したクラスの直近の親クラス名を取得するために利用されます。この関数には、クラスのインスタンス（オブジェクト）またはクラス名の文字列を引数として渡すことができます。

関数が正常に親クラス名を特定できた場合、その親クラスの名前を文字列として返します。しかし、指定されたクラスに親クラスが存在しない場合、あるいは引数として渡されたクラス名自体が存在しない場合はfalseを返します。

サンプルコードでは、MyBaseClassを継承するMyDerivedClassを例に、オブジェクトから、またはクラス名の文字列から親クラス名を取得する様子が示されています。また、MyStandaloneClassのようにどのクラスも継承していないクラスに対してこの関数を呼び出すとfalseが返されること、さらに存在しないクラス名を指定した場合もfalseが返されることが確認できます。これにより、この関数が様々な状況でどのように振る舞うかを具体的に理解することができます。

<?php

/**
 * 親クラスを定義します。
 * プロパティやコンストラクタを持ちます。
 */
class Vehicle
{
    public string $color;

    public function __construct(string $color)
    {
        $this->color = $color;
    }
}

/**
 * 子クラスを定義します。
 * Vehicle クラスを継承し、親のプロパティを引き継ぎます。
 */
class Car extends Vehicle
{
    public string $make;

    public function __construct(string $color, string $make)
    {
        // 親クラスのコンストラクタを呼び出し、親のプロパティを初期化します。
        parent::__construct($color);
        $this->make = $make;
    }
}

/**
 * get_parent_class 関数の使用例と、親クラスのプロパティへのアクセスをデモンストレーションします。
 */
function demonstrateGetParentClassAndProperties(): void
{
    // Car クラスのインスタンスを作成します。
    $myCar = new Car('Red', 'Toyota');

    // 1. オブジェクトを引数として親クラス名を取得します。
    // get_parent_class は、指定されたオブジェクトの親クラス名を文字列で返します。
    // 親クラスがない場合は false を返します。
    $parentClassByObject = get_parent_class($myCar);
    echo "オブジェクト (\$myCar) の親クラス: " . ($parentClassByObject ?: '親クラスなし') . "\n";

    // 2. クラス名を文字列として引数に親クラス名を取得します。
    // クラス名が指定された場合も同様に親クラス名を返します。
    $parentClassByString = get_parent_class('Car');
    echo "クラス名 ('Car') の親クラス: " . ($parentClassByString ?: '親クラスなし') . "\n";

    // 3. 継承された親クラスのプロパティにアクセスします。
    // Car クラスは Vehicle クラスを継承しているため、Vehicle の $color プロパティを持っています。
    echo "私の車の色 (親クラス Vehicle から継承): " . $myCar->color . "\n";
}

// デモンストレーション関数を実行します。
demonstrateGetParentClassAndProperties();

PHPのget_parent_class関数は、オブジェクト指向プログラミングにおけるクラスの継承関係を調べる際に利用される便利な機能です。この関数は、引数として指定されたオブジェクトのインスタンス、またはクラス名を文字列で受け取ります。そして、もし親クラスが存在すればそのクラス名を文字列で返し、親クラスが存在しない（つまり、それが最上位のクラスである）場合はfalseを返します。

サンプルコードでは、基本的なクラス継承の例としてVehicleクラスを親とし、Carクラスをその子として定義しています。CarクラスはVehicleクラスの$colorプロパティを継承し、自身のコンストラクタ内でparent::__constructを使って親のプロパティを適切に初期化しています。

demonstrateGetParentClassAndProperties関数内では、Carクラスのインスタンスを作成した後、get_parent_class関数を二通りの方法で呼び出す様子を示しています。一つは作成した$myCarオブジェクトを直接渡す方法、もう一つはクラス名'Car'を文字列として渡す方法です。どちらの呼び出しでも、親クラス名である'Vehicle'が正確に取得できることを確認できます。

さらに、このサンプルコードでは、子クラスのインスタンス$myCarから、親クラスVehicleから継承された$colorプロパティに直接アクセスできることを示しています。これにより、get_parent_class関数がクラス階層の動的な確認に役立つだけでなく、継承によってプロパティがどのように引き継がれ、利用されるのかを具体的に理解できるようになっています。

<?php

/**
 * 基本的なクラス階層を定義します。
 * システムエンジニアを目指す初心者がオブジェクト指向の継承を理解するのに役立ちます。
 */
class GrandParentClass
{
    // このクラスは他のクラスを継承していません。
}

class ParentClass extends GrandParentClass
{
    // このクラスは GrandParentClass を継承しています。
}

class ChildClass extends ParentClass
{
    // このクラスは ParentClass を継承しています。
}

/**
 * get_parent_class() 関数の使用方法を示すサンプルコードです。
 *
 * この関数は、指定されたオブジェクトまたはクラス名の親クラスの名前を取得するために使用されます。
 * PHP のクラス階層を理解し、実行時にクラスの関係性を調べる際に役立ちます。
 */
function demonstrateGetParentClassUsage(): void
{
    echo "--- get_parent_class() のデモンストレーション ---" . PHP_EOL;

    // 1. オブジェクトインスタンスから親クラスの名前を取得する例
    $childObject = new ChildClass();
    $parentOfChildObject = get_parent_class($childObject);

    if ($parentOfChildObject !== false) {
        echo "ChildClass のインスタンスの親クラス: " . $parentOfChildObject . PHP_EOL; // 期待される出力: ParentClass
    } else {
        echo "ChildClass のインスタンスには親クラスがありません (またはエラー発生)。" . PHP_EOL;
    }

    echo PHP_EOL; // 出力を見やすくするための改行

    // 2. クラス名文字列から親クラスの名前を取得する例
    $parentOfChildClassString = get_parent_class('ChildClass');

    if ($parentOfChildClassString !== false) {
        echo "クラス名 'ChildClass' の親クラス: " . $parentOfChildClassString . PHP_EOL; // 期待される出力: ParentClass
    } else {
        echo "クラス名 'ChildClass' には親クラスがありません (またはエラー発生)。" . PHP_EOL;
    }

    echo PHP_EOL;

    // 3. 階層の中間にあるクラスの親クラスを取得する例
    $parentOfParentClassString = get_parent_class('ParentClass');

    if ($parentOfParentClassString !== false) {
        echo "クラス名 'ParentClass' の親クラス: " . $parentOfParentClassString . PHP_EOL; // 期待される出力: GrandParentClass
    } else {
        echo "クラス名 'ParentClass' には親クラスがありません (またはエラー発生)。" . PHP_EOL;
    }

    echo PHP_EOL;

    // 4. 最上位のクラス (継承元がないクラス) の親クラスを取得する例
    // この場合、親クラスが存在しないため、get_parent_class() は false を返します。
    $parentOfGrandParentClassString = get_parent_class('GrandParentClass');

    if ($parentOfGrandParentClassString !== false) {
        echo "クラス名 'GrandParentClass' の親クラス: " . $parentOfGrandParentClassString . PHP_EOL;
    } else {
        echo "クラス名 'GrandParentClass' には親クラスがありません (最上位クラス)。" . PHP_EOL; // 期待される出力
    }

    echo PHP_EOL;

    // 5. 存在しないクラス名を渡した場合の例
    // この場合も、get_parent_class() は false を返します。
    $parentOfNonExistentClass = get_parent_class('NonExistentClass');

    if ($parentOfNonExistentClass !== false) {
        echo "存在しないクラス名 'NonExistentClass' の親クラス: " . $parentOfNonExistentClass . PHP_EOL;
    } else {
        echo "存在しないクラス名 'NonExistentClass': 親クラスが見つかりません (クラス自体が存在しない可能性があります)。" . PHP_EOL; // 期待される出力
    }
}

// 上記のデモンストレーション関数を実行します。
demonstrateGetParentClassUsage();

?>

PHPのget_parent_class()関数は、指定したクラスの直接の親クラス（継承元のクラス）の名前を取得するための関数です。オブジェクト指向プログラミングにおけるクラスの継承関係を、プログラムの実行中に動的に調べる際に役立ちます。

この関数の引数には、親クラスを調べたいオブジェクトのインスタンス、またはクラス名を文字列として指定します。関数を実行すると、親クラスが存在する場合にはそのクラス名が文字列として返されます。もし指定したクラスがどのクラスも継承していない最上位のクラスである場合や、そもそも存在しないクラス名を指定した場合には、falseが返されます。

サンプルコードでは、ChildClass、ParentClass、GrandParentClassという3つのクラスで継承関係を定義しています。get_parent_class()にChildClassのオブジェクトやクラス名を渡すと、その親であるParentClassという文字列が取得できます。同様に、ParentClassを調べるとGrandParentClassが返されます。最上位のGrandParentClassには親クラスがないため、falseが返ることを確認できます。