is_subclass_of

(PHP 4, PHP 5)

is_subclass_of — あるオブジェクトが指定したクラスのサブクラスに属するかどうかを調べる

説明

bool is_subclass_of ( mixed $object , string $class_name )

指定した object が、その親のひとつに class_name を持つかどうかを調べます。

パラメータ

object: クラス名あるいはオブジェクトのインスタンス。
class_name: クラス名。

返り値

この関数は、オブジェクト object が superclass のサブクラスであるクラスに属する場合に TRUE、その他の場合に FALSE を返します。

変更履歴

バージョン	説明
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

参考

method_exists

is_a

Last updated: Fri, 10 Oct 2008

add a note User Contributed Notes
is_subclass_of

jm
30-Sep-2008 08:02


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.

Ondra Zizka
13-Oct-2006 05:31


For PHP4:



/** 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');

gunniboyh at web dot de
20-May-2006 06:16


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

01-Oct-2005 06:32


this function does not check interfaces, unlike instanceof operator.

youcantryreachingme at REMOVEME dot hotmail dot com
21-Mar-2005 06:15


A bug report at http://pear.php.net/bugs/bug.php?id=2975 indicates that the "is_subclass_of" function can return the error message:



Warning: Unknown class passed as parameter



in the event that the class represented by the second argument hasn't yet been instantiated.

add a note

method_exists

is_a

Last updated: Fri, 10 Oct 2008