is_subclass_of

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

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

Описание

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

Функция проверяет, принадлежит ли объект или класс object_or_class к потомкам класса class, или реализует ли объект или класс, или родители объекта или класса, интерфейс.

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

object_or_class: Имя класса или экземпляр объекта. Если класс не найден, ошибка не будет выдана.
class: Имя класса.
allow_string: Если для параметра установили значение false, функция определит принадлежность типа объекта, который проверяют, к подтипу класса, только если в параметр object_or_class передадут экземпляр объекта, а не имя класса. Это также предотвратит вызов автозагрузчика, если класс не найден.

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

Функция возвращает true, если объект или класс object_or_class принадлежит к потомкам класса class, или если объект или класс, или предок объекта или класса, реализует интерфейс, иначе false.

Примеры

Пример #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";
}

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() - Возвращает список родительских классов заданного класса

Improve This Page

Learn how improve this page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 3 notes

down

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

down

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.

down

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