property_exists

オブジェクトもしくはクラスにプロパティが存在するかどうかを調べる

説明

bool property_exists(objectstring $object_or_class, string $property)

この関数は、与えられたプロパティ property が 指定されたクラスに存在するかどうかを確認します。

注意: isset とは対照的に、 プロパティの値が null の場合でも property_exists は true を返します。

パラメータ

object_or_class

確認するクラス名、もしくはクラスのオブジェクトを指定します。

property

プロパティ名を指定します。

戻り値

プロパティが存在している場合は true、存在していない場合に false を返します。

例

例1 property_exists の例

<?php

class myClass {
    public $mine;
    private $xpto;
    static protected $test;

    static function test() {
        var_dump(property_exists('myClass', 'xpto')); //true
    }
}

var_dump(property_exists('myClass', 'mine'));   //true
var_dump(property_exists(new myClass, 'mine')); //true
var_dump(property_exists('myClass', 'xpto'));   //true
var_dump(property_exists('myClass', 'bar'));    //false
var_dump(property_exists('myClass', 'test'));   //true
myClass::test();

?>

property_exists は、プロパティのアクセス権に関係なく true を返し、 インスタンスに追加された動的なプロパティ (クラスに #[AllowDynamicProperties] が付いている場合) も検出し、 マジックメソッド __isset と __get は無視します。

例2 アクセス権、動的なプロパティ、マジックメソッド

<?php

#[AllowDynamicProperties]
class MyClass {
    public $public;
    private $private;
    static protected $protectedStatic;

    // property_exists では無視される
    public function __isset(string $name): bool {
        return true;
    }

    // property_exists では無視される
    public function __get(string $name): string {
        return '';
    }
}

$instance = new MyClass();
$instance->instanced = 'abc';

var_dump(property_exists($instance, 'public'));          // true  (public)
var_dump(property_exists($instance, 'private'));         // true  (アクセス権は無視される)
var_dump(property_exists($instance, 'protectedStatic')); // true  (アクセス権は無視される)
var_dump(property_exists($instance, 'instanced'));       // true  (インスタンスの動的なプロパティ)
var_dump(property_exists($instance, 'undefined'));       // false (宣言されておらず、__isset は無視される)

var_dump(property_exists(MyClass::class, 'public'));    // true
var_dump(property_exists(MyClass::class, 'instanced')); // false (動的なプロパティはクラスにはない)
var_dump(property_exists(MyClass::class, 'undefined')); // false

?>

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

bool(true)
bool(true)
bool(true)
bool(true)
bool(false)
bool(true)
bool(false)
bool(false)

注意

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

注意:

property_exists 関数は、マジックメソッド __get を使ってアクセスするプロパティを検出することはできません。

参考

  • method_exists