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 を持つか (あるいは class_name を実装しているか) どうかを調べます。

パラメータ

object

クラス名あるいはオブジェクトのインスタンス。 そのクラスが存在しなくても、エラーにはなりません。

class_name

クラス名。

allow_string

このパラメータを false にすると、 クラス名を表す文字列を object に指定できなくなります。 そして、クラスが存在しない場合のオートローダーの呼び出しもしなくなります。

返り値

この関数は、オブジェクト objectsuperclass のサブクラスであるクラスに属する場合に TRUE、その他の場合に 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 
"yes, \$WFC is a subclass of WidgetFactory\n";
} else {
  echo 
"no, \$WFC is not a subclass of WidgetFactory\n";
}


if (
is_subclass_of($WF'WidgetFactory')) {
  echo 
"yes, \$WF is a subclass of WidgetFactory\n";
} else {
  echo 
"no, \$WF is not a subclass of WidgetFactory\n";
}


// PHP 5.0.3 以降で使用可能
if (is_subclass_of('WidgetFactory_Child''WidgetFactory')) {
  echo 
"yes, WidgetFactory_Child is a subclass of WidgetFactory\n";
} else {
  echo 
"no, WidgetFactory_Child is not a subclass of WidgetFactory\n";
}
?>

上の例の出力は以下となります。

yes, $WFC is a subclass of WidgetFactory
no, $WF is not a subclass of WidgetFactory
yes, WidgetFactory_Child is a subclass of WidgetFactory

例2 is_subclass_of() でインターフェイスを使う例

<?php
// インターフェイスの定義
interface MyInterface
{
  public function 
MyFunction();
}

// インターフェイスの実装クラスの定義
class MyClass implements MyInterface
{
  public function 
MyFunction()
  {
    return 
"MyClass Implements MyInterface!";
  }
}

// オブジェクトのインスタンスを作ります
$my_object = new MyClass;

// 次の例は 5.3.7 以降で動作します

// クラスのインスタンスを調べます
if (is_subclass_of($my_object'MyInterface')) {
  echo 
"Yes, \$my_object is a subclass of MyInterface\n";
} else {
  echo 
"No, \$my_object is not a subclass of MyInterface\n";
}

// クラス名を表す文字列を調べます
if (is_subclass_of('MyClass''MyInterface')) {
  echo 
"Yes, MyClass is a subclass of MyInterface\n";
} else {
  echo 
"No, MyClass is not a subclass of MyInterface\n";
}
?>

上の例の出力は以下となります。

Yes, $my_object is a subclass of MyInterface
Yes, MyClass is a subclass of MyInterface

注意

注意:

この関数を使うと、未知のクラスに対しては登録済みの autoloader を使用します。

参考

  • get_class() - オブジェクトのクラス名を返す
  • get_parent_class() - オブジェクトの親クラスの名前を取得する
  • is_a() - オブジェクトがこのクラスのものであるか、このクラスをその親クラスのひとつとしているかどうかを調べる
  • class_parents() - 与えられたクラスの親クラスを返す

add a note add a note

User Contributed Notes 6 notes

up
7
gunniboyh at web dot de
10 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
4
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
1
jm
8 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
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
Ondra Zizka
10 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
-1
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