PHP Unconference Europe 2015

is_subclass_of

(PHP 4, PHP 5)

is_subclass_ofDétermine si un objet est une sous-classe d'une classe donnée

Description

bool is_subclass_of ( mixed $object , string $class_name [, bool $allow_string = TRUE ] )

Vérifie si l'objet object a la classe class_name parmi ses parents.

Liste de paramètres

object

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

class_name

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 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 est une instance d'une classe qui est une sous-classe de class_name, FALSE sinon.

Historique

Version Description
5.3.9 Ajout du paramètre allow_string.
5.3.7 Ajout du support pour class_name pour fonctionner avec les interfaces
5.0.3 vous pouvez également spécifier le paramètre object en tant que chaîne de caractères (le nom de la classe).

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";
}


// utilisable uniquement depuis PHP 5.0.3
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
Yes, MyClass est une sous-classe de MyInterface

Notes

Note:

L'usage de cette fonction utilisera toutes 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 la classe parente d'une classe

add a note add a note

User Contributed Notes 6 notes

up
2
gunniboyh at web dot de
8 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
1
nicholas at aquarionics dot com
5 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
kostyl_kostyl gav-gav mail point ru
5 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
0
Damien Bezborodov
5 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
0
jm
6 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
0
Ondra Zizka
8 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