PHPのお勉強！

PHP TOP
PHP 8.4.2 Released!

    is_subclass_of

    (PHP 4, PHP 5, PHP 7, PHP 8)

    is_subclass_of — あるオブジェクトが指定したクラスのサブクラスに属するか (あるいは指定したインターフェイスを実装しているか) どうかを調べる

    説明

    is_subclass_of(mixed $object_or_class, string $class, bool $allow_string = true): bool

    指定した object_or_class が、その親のひとつに class を持つか (あるいは class を実装しているか) どうかを調べます。

    パラメータ

    object_or_class

    クラス名あるいはオブジェクトのインスタンス。 そのクラスが存在しなくても、エラーにはなりません。

    class

    クラス名。

    allow_string

    このパラメータを false にすると、 クラス名を表す文字列を object_or_class に指定できなくなります。 そして、クラスが存在しない場合のオートローダーの呼び出しもしなくなります。

    戻り値

    この関数は、オブジェクト object_or_class が class のサブクラスであるクラスに属する場合に true、その他の場合に false を返します。

    例

    例1 is_subclass_of() の例

    <?php
    // クラスを定義する
    class WidgetFactory
    {
    var     $oink = 'moo';
    }

    // 子クラスを定義する
    class WidgetFactory_Child extends WidgetFactory
    {
    var     $oink = 'oink';
    }

    // 新規オブジェクトを生成する
    $WF = new WidgetFactory();
    $WFC = new WidgetFactory_Child();

    if (    is_subclass_of($WFC, 'WidgetFactory')) {
    echo     "yes, \$WFC is a subclass of WidgetFactory\n";
    } else {
    echo     "no, \$WFC is not a subclass of WidgetFactory\n";
    }


    if (    is_subclass_of($WF, 'WidgetFactory')) {
    echo     "yes, \$WF is a subclass of WidgetFactory\n";
    } else {
    echo     "no, \$WF is not a subclass of WidgetFactory\n";
    }


    if (    is_subclass_of('WidgetFactory_Child', 'WidgetFactory')) {
    echo     "yes, WidgetFactory_Child is a subclass of WidgetFactory\n";
    } else {
    echo     "no, WidgetFactory_Child is not a subclass of WidgetFactory\n";
    }
    ?>

    上の例の出力は以下となります。

    yes, $WFC is a subclass of WidgetFactory
no, $WF is not a subclass of WidgetFactory
yes, WidgetFactory_Child is a subclass of WidgetFactory

    例2 is_subclass_of() でインターフェイスを使う例

    <?php
    // インターフェイスの定義
    interface MyInterface
    {
    public function     MyFunction();
    }

    // インターフェイスの実装クラスの定義
    class MyClass implements MyInterface
    {
    public function     MyFunction()
    {
    return     "MyClass Implements MyInterface!";
    }
    }

    // オブジェクトのインスタンスを作ります
    $my_object = new MyClass;

    // 次の例は 5.3.7 以降で動作します

    // クラスのインスタンスを調べます
    if (is_subclass_of($my_object, 'MyInterface')) {
    echo     "Yes, \$my_object is a subclass of MyInterface\n";
    } else {
    echo     "No, \$my_object is not a subclass of MyInterface\n";
    }

    // クラス名を表す文字列を調べます
    if (is_subclass_of('MyClass', 'MyInterface')) {
    echo     "Yes, MyClass is a subclass of MyInterface\n";
    } else {
    echo     "No, MyClass is not a subclass of MyInterface\n";
    }
    ?>

    上の例の出力は以下となります。

    Yes, $my_object is a subclass of MyInterface
Yes, MyClass is a subclass of MyInterface

    注意

    注意:

    この関数を使うと、未知のクラスに対しては登録済みの autoloader を使用します。

    参考

    • get_class() - オブジェクトのクラス名を返す
    • get_parent_class() - オブジェクトの親クラスの名前を取得する
    • is_a() - オブジェクトが指定された型のものか、部分型であるかを調べる
    • class_parents() - 与えられたクラスの親クラスを返す

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 3 notes

    up
    17
    gunniboyh at web dot de
    18 years ago
    is_subclass_of() works also with classes between the class of obj and the superclass.

    example:
    <?php
    class A {};
    class     B extends A {};
    class     C extends B {};

    $foo=new C();
    echo ((    is_subclass_of($foo,'A')) ? 'true' : 'false');
    ?>

    echoes 'true' .
    up
    10
    nicholas at aquarionics dot com
    15 years ago
    This might be useful to someone, so:

    If you're using Autoload, you should be aware that this will attempt to autoload $classname if it isn't already loaded. I discovered this when I had something using is_subclass_of inside an error thrown by autoload, which then recursed until it ran out of memory.
    up
    2
    alan at jynxy.net
    6 years ago
    The $allow_string parameter is not very clearly documented. When true, it simply allows the first parameter to be the name of a class, instead of an object whose class we are interested in.

    Some usage examples:

    class parent_class {
    // objects and methods ...
    }

    $possible_child_object = new possible_child_class(); // might be an extension of parent_class

    $result = is_subclass_of($possible_child_object, 'parent_class'); // valid
    $result = is_subclass_of($possible_child_object, 'parent_class', false); // valid
    $result = is_subclass_of('possible_child_class', 'parent_class', true); // valid
    $result = is_subclass_of('possible_child_class', 'parent_class', false); // not valid
    ＋add a note
    To Top