クラス/オブジェクト関数
PHP Manual

is_subclass_of

(PHP 4, PHP 5)

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 に指定できなくなります。 そして、クラスが存在しない場合のオートローダーの呼び出しもしなくなります。

返り値

この関数は、オブジェクト 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 を使用します。

参考


クラス/オブジェクト関数
PHP Manual