PHP 8.1.28 Released!

    is_subclass_of

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

    is_subclass_of — Verifica se o objeto tem esta classe como uma de suas classes pai

    Descrição

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

    Verifica se object_or_class informado tem a classe class como uma de suas classes pai ou o/a implementa.

    Parâmetros

    object_or_class

    O nome da classe ou um instância do objeto. Nenhum erro é gerado se a classe não existir.

    class

    O nome da classe

    allow_string

    Se este parâmetro for definido para falso, nome de classe em string no parâmetro object_or_class não será permitido. Isto também evita chamada ao carregamento automático se a classe não existir.

    Valor Retornado

    Esta função retorna true se o objeto object_or_class, pertencer a uma classe que é uma subclasse de class, false caso contrário.

    Exemplos

    Exemplo #1 Exemplo de is_subclass_of()

    <?php
    // define uma classe
    class WidgetFactory
    {
    var     $oink = 'moo';
    }

    // define uma classe filha
    class WidgetFactory_Child extends WidgetFactory
    {
    var     $oink = 'oink';
    }

    // cria um novo objeto
    $WF = new WidgetFactory();
    $WFC = new WidgetFactory_Child();

    if (    is_subclass_of($WFC, 'WidgetFactory')) {
    echo     "sim, \$WFC é uma subclasse de WidgetFactory\n";
    } else {
    echo     "não, \$WFC não é uma subclasse de WidgetFactory\n";
    }


    if (    is_subclass_of($WF, 'WidgetFactory')) {
    echo     "sim, \$WF é uma subclasse de WidgetFactory\n";
    } else {
    echo     "não, \$WF não é uma subclasse de WidgetFactory\n";
    }


    if (    is_subclass_of('WidgetFactory_Child', 'WidgetFactory')) {
    echo     "sim, WidgetFactory_Child é uma subclasse de WidgetFactory\n";
    } else {
    echo     "não, WidgetFactory_Child não é uma subclasse de WidgetFactory\n";
    }
    ?>

    O exemplo acima produzirá:

    sim, $WFC é uma subclasse de WidgetFactory
não, $WF não é uma subclasse de WidgetFactory
sim, WidgetFactory_Child é uma subclasse de WidgetFactory

    Exemplo #2 Exemplo de is_subclass_of() usando interface

    <?php
    // Define a Interface
    interface MyInterface
    {
    public function     MyFunction();
    }

    // Define a implementação de classe da interface
    class MyClass implements MyInterface
    {
    public function     MyFunction()
    {
    return     "MyClass Implementa MyInterface!";
    }
    }

    // Instancia o objeto object
    $my_object = new MyClass;

    // Funciona desde 5.3.7

    // Teste usando a instância do objeto da classe
    if (is_subclass_of($my_object, 'MyInterface')) {
    echo     "Sim, \$my_object é uma subclasse de MyInterface\n";
    } else {
    echo     "No, \$my_object não é uma subclasse de MyInterface\n";
    }

    // Teste usando a string do nome da classe
    if (is_subclass_of('MyClass', 'MyInterface')) {
    echo     "Sim, MyClass é uma subclasse de MyInterface\n";
    } else {
    echo     "No, MyClass não é uma subclasse de MyInterface\n";
    }
    ?>

    O exemplo acima produzirá:

    Sim, $my_object é uma subclasse de MyInterface
Sim, MyClass é uma subclasse de MyInterface

    Notas

    Nota:

    Usar esta função fará com que qualquer autoloader registrado seja usado se a classe ainda não for conhecida.

    Veja Também

    Improve This Page

    Learn how 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
    17 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
    5 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