is_subclass_of
(PHP 4, PHP 5, PHP 7)
is_subclass_of — Проверяет, содержит ли объект в своем дереве предков указанный класс
Описание
Проверяет, содержит ли объект 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() - Возвращает список родительских классов заданного класса
- PHP Руководство
- Функции по категориям
- Индекс функций
- Справочник функций
- Расширения, относящиеся к переменным и типам
- Функции работы с классами и объектами
- __autoload
- call_user_method_array
- call_user_method
- class_alias
- class_exists
- get_called_class
- get_class_methods
- get_class_vars
- get_class
- get_declared_classes
- get_declared_interfaces
- get_declared_traits
- get_object_vars
- get_parent_class
- interface_exists
- is_a
- is_subclass_of
- method_exists
- property_exists
- trait_exists
Коментарии
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' .
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.
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