PHP 8.1.0 Released!

is_subclass_of

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

is_subclass_ofDétermine si un objet est une sous-classe d'une classe donnée ou l'implémente

Description

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

Vérifie si l'objet object_or_class a la classe class parmi ses parents ou l'implémente.

Liste de paramètres

object_or_class

Un nom de classe ou une instance d'un objet. Aucune erreur n'est générée si la classe n'existe pas.

class

Le nom de la classe

allow_string

Si ce paramètre est défini à false, un nom de classe sous forme de chaîne de caractères dans le paramètre object_or_class n'est pas autorisé. Ceci permet d'éviter d'appeler l'autoloader si la classe n'existe pas.

Valeurs de retour

Cette fonction retourne true si l'objet object_or_class est une instance d'une classe qui est une sous-classe de class, false sinon.

Exemples

Exemple #1 Exemple avec is_subclass_of()

<?php
// Définit une classe
class WidgetFactory
{
  var 
$oink 'moo';
}

// Définit une sous-classe
class WidgetFactory_Child extends WidgetFactory
{
  var 
$oink 'oink';
}

// Création d'un nouvel objet
$WF = new WidgetFactory();
$WFC = new WidgetFactory_Child();

if (
is_subclass_of($WFC'WidgetFactory')) {
  echo 
"oui, \$WFC est une sous-classe de la classe WidgetFactory\n";
} else {
  echo 
"non, \$WFC n'est pas une sous-classe de la classe WidgetFactory\n";
}


if (
is_subclass_of($WF'WidgetFactory')) {
  echo 
"oui, \$WF est une sous-classe de la classe WidgetFactory\n";
} else {
  echo 
"non, \$WF n'est pas une sous-classe de la classe WidgetFactory\n";
}


if (
is_subclass_of('WidgetFactory_Child''WidgetFactory')) {
  echo 
"oui, WidgetFactory_Child est une sous-classe de la classe WidgetFactory\n";
} else {
  echo 
"non, WidgetFactory_Child n'est pas une sous-classe de la classe WidgetFactory\n";
}
?>

L'exemple ci-dessus va afficher :

oui, $WFC est une sous-classe de la classe WidgetFactory
non, $WF n'est pas une sous-classe de la classe WidgetFactory
oui, WidgetFactory_Child est une sous-classe de la classe WidgetFactory

Exemple #2 Exemple avec is_subclass_of() en utilisant une interface

<?php
// Définition de l'interface
interface MyInterface
{
  public function 
MyFunction();
}

// Définition de l'implémentation de la classe de l'interface
class MyClass implements MyInterface
{
  public function 
MyFunction()
  {
    return 
"MyClass implémente MyInterface!";
  }
}

// Instanciation de l'objet
$my_object = new MyClass;

// Fonctionne depuis PHP 5.3.7

// Test utilisant l'objet de l'instance de la classe
if (is_subclass_of($my_object'MyInterface')) {
  echo 
"Oui, \$my_object est une sous-classe de MyInterface\n";
} else {
  echo 
"Non, \$my_object n'est pas une sous-classe de MyInterface\n";
}

// Test utilisant le nom de la classe sous forme de chaîne de caractères
if (is_subclass_of('MyClass''MyInterface')) {
  echo 
"Oui, MyClass est une sous-classe de MyInterface\n";
} else {
  echo 
"Non, MyClass n'est pas une sous-classe de MyInterface\n";
}
?>

L'exemple ci-dessus va afficher :

Oui, $my_object est une sous-classe de MyInterface
Oui, MyClass est une sous-classe de MyInterface

Notes

Note:

L'usage de cette fonction utilisera tous les autoloaders enregistrés si la classe n'est pas encore connue.

Voir aussi

  • get_class() - Retourne le nom de la classe d'un objet
  • get_parent_class() - Retourne le nom de la classe parente d'un objet
  • is_a() - Vérifie si l'objet est une instance d'une classe donnée ou a cette classe parmi ses parents
  • class_parents() - Retourne les classes parentes d'une classe

add a note add a note

User Contributed Notes 7 notes

up
14
gunniboyh at web dot de
15 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
9
nicholas at aquarionics dot com
12 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
1
alan at jynxy.net
3 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
up
0
Damien Bezborodov
12 years ago
If you need something similar to is_subclass_of() to determine if a class implements an interface before instantiating it, use reflection:

<?php

interface A_Interface {}
class
A implements A_Interface {}

$reflectionA = new ReflectionClass('A');
var_dump(
   
$reflectionA->implementsInterface('A_Interface')
);

?>
bool(true)
up
-2
jm
13 years ago
It would appear that is_subclass_of is case insensitive unlike get_class in php5.
i.e.

<?php
class fooBar {}
class
bar extends fooBar {}

assert(get_class(new fooBar()) == "fooBar");
assert(is_subclass_of(new bar(), "foobar") == true);
?>

i run across this while migrating some code from php4 to php5 and the code would only half-the-time break.
up
-5
kostyl_kostyl gav-gav mail point ru
12 years ago
<?php
interface I {
}
class
A implements I {
}
class
B extends {
}
if (
is_subclass_of('A', 'I')) {
    echo
'good<br>';
}
else {
    echo
'bad<br>';
}
if (
is_subclass_of('B', 'I')) {
    echo
'good<br>';
}
else {
    echo
'bad<br>';
}
if (
is_subclass_of('B', 'A')) {
    echo
'good<br>';
}
else {
    echo
'bad<br>';
}
?>

result:
bad <- you must to describe intermediate class B to be good
good
good
up
-6
Ondra Zizka
15 years ago
For PHP4:

<?php
/** Returns whether specified class is subclass of the other class. */
function is_subclass($sClass, $sExpectedParentClass){
    do if(
$sExpectedParentClass === $sClass ) return true;
    while(
false != ($sClass = get_parent_class($sClass)) );
    return
false;
}
// Test:
class A {} class B extends A {} class C extends B {} echo (int) is_subclass('C', 'A');
?>
To Top