PHP – クラスの確認

1 概要
2 instanceof/is_a()
- 2.1 instanceof
- 2.2 is_a()
3 is_subclass_of()
4 class_uses()
5 method_exists()/property_exists()

概要

instanceof：値のクラスをチェック
is_a()：値のクラスをチェック
is_subclass_of()：値の親クラスをチェック
class_uses()：トレイトを使っているかどうかチェック

instanceof/is_a()

instanceof

インスタンス instanceof クラス等名

instanceofは、第1オペランドが第2オペランドのクラスに合致しているかどうかをチェックする演算子。第2オペランドにはクラス名などをそのまま記述する。is_a()関数と同じ機能。

以下の例の様に、instanceofは、

そのインスタンスのクラス、継承した親クラス、インプリメントしたインターフェイスに対して真となる
トレイトについてはuseしていても真とはならない

trait MyTrait {
  public function traitMethod() {}
}

interface MyInterface {}

class MyParent {
  public function parentMethod() {}
}

class MyChild extends MyParent implements MyInterface {
  use MyTrait;

  public function childMethod() {}
}

class GrandChild extends MyChild {}

$child = new MyChild();

$child = new MyChild();

echo $child instanceof MyChild ? "true\n" : "false\n";
echo $child instanceof MyParent ? "true\n" : "false\n";
echo $child instanceof MyInterface ? "true\n" : "false\n";
echo $child instanceof MyTrait ? "true\n" : "false\n";

// true
// true
// true
// false

trait MyTrait {

public function traitMethod() {}

}

interface MyInterface {}

class MyParent {

public function parentMethod() {}

}

class MyChild extends MyParent implements MyInterface {

use MyTrait;

public function childMethod() {}

}

class GrandChild extends MyChild {}

$child = new MyChild();

echo $child instanceof MyChild ? "true\n" : "false\n";

echo $child instanceof MyParent ? "true\n" : "false\n";

echo $child instanceof MyInterface ? "true\n" : "false\n";

echo $child instanceof MyTrait ? "true\n" : "false\n";

// true

// false

is_a()

is_a(インスタンス, 'クラス等名');

is_a()は第1引数のインスタンスが第2引数のクラスに合致しているかどうかチェックする。第2引数のクラス名は文字列として与える。

以下の例のように、親クラス、インターフェイス、トレイトに対する判定はinstanceofと同じ。

echo is_a($child, 'MyChild') ? "true\n" : "false\n";
echo is_a($child, 'MyParent') ? "true\n" : "false\n";
echo is_a($child, 'MyInterface') ? "true\n" : "false\n";
echo is_a($child, 'MyTrait') ? "true\n" : "false\n";

// true
// true
// true
// false

echo is_a($child, 'MyChild') ? "true\n" : "false\n";

echo is_a($child, 'MyParent') ? "true\n" : "false\n";

echo is_a($child, 'MyInterface') ? "true\n" : "false\n";

echo is_a($child, 'MyTrait') ? "true\n" : "false\n";

// true

// false

is_subclass_of()

is_subclass_of(インスタンス, 'クラス等名');

is_subclass_of()は、第1引数のインスタンスのクラスが第2引数のクラスを継承しているかどうかをチェックする。引数の渡し方はis_a()と同じ。

以下の例のように、

引数のインスタンスのクラスそのものは偽
継承した親クラスとインターフェースに対しては真
トレイトは偽

echo is_subclass_of($child, 'MyChild') ? "true\n" : "false\n";
echo is_subclass_of($child, 'MyParent') ? "true\n" : "false\n";
echo is_subclass_of($child, 'MyInterface') ? "true\n" : "false\n";
echo is_subclass_of($child, 'MyTrait') ? "true\n" : "false\n";

// false
// true
// true
// false

echo is_subclass_of($child, 'MyChild') ? "true\n" : "false\n";

echo is_subclass_of($child, 'MyParent') ? "true\n" : "false\n";

echo is_subclass_of($child, 'MyInterface') ? "true\n" : "false\n";

echo is_subclass_of($child, 'MyTrait') ? "true\n" : "false\n";

// false

// true

// false

class_uses()

class_uses(インスタンス);

class_uses()は、引数インスタンスのクラスがuseしているトレイト連想配列として返す。連想配列のキー・値とも、トレイト名の文字列。

var_dump(class_uses($child));

// array(1) {
//   ["MyTrait"]=>
//   string(7) "MyTrait"
// }

var_dump(class_uses($child));

// array(1) {

// ["MyTrait"]=>

// string(7) "MyTrait"

// }

トレイトをuseしているかどうかをチェックするには、class_uses()の結果の連想配列に対して、in_array()かarray_key_exists()でトレイト名が含まれるかどうかをチェック。

echo in_array('MyTrait', class_uses($child)) ? "true\n" : "false\n";

// true

echo in_array('MyTrait', class_uses($child)) ? "true\n" : "false\n";

// true

親クラスでトレイトをuseしていても、子クラスのclass_uses()では捕捉されない。

$grandchild = new GrandChild();
var_dump(class_uses($grandchild));

// array(0) {
// }

$grandchild = new GrandChild();

var_dump(class_uses($grandchild));

// array(0) {

// }

method_exists()/property_exists()

method_exists(インスタンス, ’クラス等名’)
property_exists(インスタンス, ’クラス等名’)

method_exists()は、第1引数で指定したインスタンスのクラスに第2引数で指定したメソッドが定義されているかどうかをチェックする。同様に、property_exists()はプロパティーが定義されているかどうかをチェックする。

以下の例で、method_exists()について確認する。

指定したメソッドが定義されていればtrue、定義されていなければfalse
親クラスのメソッドでも存在する(true)と判定(public～privateに関わらない)
トレイトのメソッドも存在すると判定
親クラスでuseされたトレイトのメソッドは、子クラスでも存在すると判定

echo method_exists($child, 'childMethod') ? "true\n" : "false\n";
echo method_exists($child, 'anotherMethod') ? "true\n" : "false\n";
echo method_exists($child, 'parentMethod') ? "true\n" : "false\n";
echo method_exists($child, 'traitMethod') ? "true\n" : "false\n";
echo method_exists($grandchild, 'traitMethod') ? "true\n" : "false\n";

// true
// false
// true
// true

echo method_exists($child, 'childMethod') ? "true\n" : "false\n";

echo method_exists($child, 'anotherMethod') ? "true\n" : "false\n";

echo method_exists($child, 'parentMethod') ? "true\n" : "false\n";

echo method_exists($child, 'traitMethod') ? "true\n" : "false\n";

echo method_exists($grandchild, 'traitMethod') ? "true\n" : "false\n";

// true

// false

// true

TauStation

PHP – クラスの確認

概要

instanceof/is_a()

instanceof

is_a()

is_subclass_of()

class_uses()

method_exists()/property_exists()

1件のコメント

コメントを残すコメントをキャンセル

概要

instanceof/is_a()

instanceof

is_a()

is_subclass_of()

class_uses()

method_exists()/property_exists()

1件のコメント

コメントを残す コメントをキャンセル

コメントを残すコメントをキャンセル