is_subclass_of

(PHP 4, PHP 5, PHP 7)

is_subclass_ofПроверяет, содержит ли объект в своем дереве предков указанный класс либо прямо реализует его

Описание

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

Проверяет, содержит ли объект object в своем дереве предков класс class_name либо прямо реализует его.

Список параметров

object

Имя класса или экземпляр объекта. В случае отсутствия такого класса никакой ошибки сгенерировано не будет.

class_name

Имя класса

allow_string

Если параметр установлен в false, то не допускается имя класса в виде строки в качестве параметра object. Это также предотвращает вызов автозагрузчика, если класс не существует.

Возвращаемые значения

Эта функция возвращает TRUE, если объект object принадлежит к классу, наследующему от class_name, иначе она возвращает FALSE.

Список изменений

Версия Описание
5.3.9 Добавлен параметр allow_string
5.3.7 Добавлена поддержка работы с интерфейсами для параметра class_name
5.0.3 Вы также можете передать параметр object в виде строки (имени класса)

Примеры

Пример #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 
"да, \$WFC наследует WidgetFactory\n";
} else {
  echo 
"нет, \$WFC не наследует WidgetFactory\n";
}


if (
is_subclass_of($WF'WidgetFactory')) {
  echo 
"да, \$WF наследует WidgetFactory\n";
} else {
  echo 
"нет, \$WF не наследует WidgetFactory\n";
}


// применимо только с версии PHP 5.0.3
if (is_subclass_of('WidgetFactory_Child''WidgetFactory')) {
  echo 
"да, WidgetFactory_Child наследует WidgetFactory\n";
} else {
  echo 
"нет, WidgetFactory_Child не наследует WidgetFactory\n";
}
?>

Результат выполнения данного примера:

да, $WFC наследует WidgetFactory
нет, $WF не наследует WidgetFactory
да, WidgetFactory_Child наследует WidgetFactory

Пример #2 Пример использования интерфейсов и is_subclass_of()

<?php
// Определяем интерфейс
interface MyInterface
{
  public function 
MyFunction();
}

// Определяем класс с реализацией интерфейса
class MyClass implements MyInterface
{
  public function 
MyFunction()
  {
    return 
"MyClass реализует MyInterface!";
  }
}

// Создаем объект
$my_object = new MyClass;

// Код ниже работает начиная с PHP 5.3.7

// Проверка с помощью экземпляра объекта
if (is_subclass_of($my_object'MyInterface')) {
  echo 
"Да, \$my_object является подклассом MyInterface\n";
} else {
  echo 
"Нет, \$my_object не является подклассом MyInterface\n";
}

// Проверка с помощью имени класса в виде строки
if (is_subclass_of('MyClass''MyInterface')) {
  echo 
"Да, MyClass является подклассом MyInterface\n";
} else {
  echo 
"Нет, MyClass не является подклассом MyInterface\n";
}
?>

Результат выполнения данного примера:

Да, $my_object является подклассом MyInterface
Да, MyClass является подклассом MyInterface

Примечания

Замечание:

Вызов этой функции будет использовать все зарегистрированные функции автозагрузки, если класс еще не известен.

Смотрите также

  • get_class() - Возвращает имя класса, к которому принадлежит объект
  • get_parent_class() - Возвращает имя родительского класса для объекта или класса
  • is_a() - Проверяет, принадлежит ли объект к данному классу или является ли этот класс одним из его родителей
  • class_parents() - Возвращает список родительских классов заданного класса

add a note add a note

User Contributed Notes 6 notes

up
6
nicholas at aquarionics dot com
8 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
6
gunniboyh at web dot de
11 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
0
Damien Bezborodov
8 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
9 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
-2
Ondra Zizka
11 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');
?>
up
-4
kostyl_kostyl gav-gav mail point ru
8 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
To Top