is_subclass_of

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

is_subclass_of — Determina si un objeto es una subclase de una clase dada o la implementa

Descripción

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

Verifica si el objeto object_or_class tiene la clase class entre sus padres o la implementa.

Parámetros

object_or_class: Un nombre de clase o una instancia de un objeto. No se genera ningún error si la clase no existe.
class: El nombre de la clase
allow_string: Si este argumento es establecido a false, un nombre de clase en forma de string en el argumento object_or_class no es permitido. Esto permite evitar llamar al autoloader si la clase no existe.

Valores devueltos

Esta función retorna true si el objeto object_or_class es una instancia de una clase que es una subclase de class, false en caso contrario.

Ejemplos

Ejemplo #1 Ejemplo con is_subclass_of()

<?php
// Define una clase
class WidgetFactory
{
  var $oink = 'moo';
}

// Define una subclase
class WidgetFactory_Child extends WidgetFactory
{
  var $oink = 'oink';
}

// Creación de un nuevo objeto
$WF = new WidgetFactory();
$WFC = new WidgetFactory_Child();

if (is_subclass_of($WFC, 'WidgetFactory')) {
  echo "sí, \$WFC es una subclase de la clase WidgetFactory\n";
} else {
  echo "no, \$WFC no es una subclase de la clase WidgetFactory\n";
}

if (is_subclass_of($WF, 'WidgetFactory')) {
  echo "sí, \$WF es una subclase de la clase WidgetFactory\n";
} else {
  echo "no, \$WF no es una subclase de la clase WidgetFactory\n";
}

if (is_subclass_of('WidgetFactory_Child', 'WidgetFactory')) {
  echo "sí, WidgetFactory_Child es una subclase de la clase WidgetFactory\n";
} else {
  echo "no, WidgetFactory_Child no es una subclase de la clase WidgetFactory\n";
}
?>

El resultado del ejemplo sería:

sí, $WFC es una subclase de la clase WidgetFactory
no, $WF no es una subclase de la clase WidgetFactory
sí, WidgetFactory_Child es una subclase de la clase WidgetFactory

Ejemplo #2 Ejemplo con is_subclass_of() utilizando una interfaz

<?php
// Definición de la interfaz
interface MyInterface
{
  public function MyFunction();
}

// Definición de la implementación de la clase de la interfaz
class MyClass implements MyInterface
{
  public function MyFunction()
  {
    return "MyClass implementa MyInterface!";
  }
}

// Instanciación del objeto
$my_object = new MyClass;

// Funciona desde PHP 5.3.7

// Prueba utilizando el objeto de la instancia de la clase
if (is_subclass_of($my_object, 'MyInterface')) {
  echo "Sí, \$my_object es una subclase de MyInterface\n";
} else {
  echo "No, \$my_object no es una subclase de MyInterface\n";
}

// Prueba utilizando el nombre de la clase en forma de string
if (is_subclass_of('MyClass', 'MyInterface')) {
  echo "Sí, MyClass es una subclase de MyInterface\n";
} else {
  echo "No, MyClass no es una subclase de MyInterface\n";
}
?>

El resultado del ejemplo sería:

Sí, $my_object es una subclase de MyInterface
Sí, MyClass es una subclase de MyInterface

Notas

Nota:
Esta función cargará cualquier autocargador registrado si la clase todavía no existe.

Ver también

get_class() - Devuelve el nombre de la clase de un objeto
get_parent_class() - Devuelve el nombre de la clase padre de un objeto
is_a() - Verifica si el objeto es de un cierto tipo o subtipo.
class_parents() - Devuelve las clases padre de la clase dada.

Found A Problem?

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

＋add a note

User Contributed Notes 3 notes

down

gunniboyh at web dot de ¶

19 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' .

down

nicholas at aquarionics dot com ¶

16 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.

down

alan at jynxy.net ¶

7 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