PHPでオブジェクトやクラスにプロパティが存在するかどうかを確認する方法

PHPでは、property_exists()関数またはisset()関数を使うことで、クラスやオブジェクト内に特定のプロパティが存在するかどうかを簡単に確認できます。それぞれの特徴や使い方の違いを理解しておくと、状況に応じて適切な関数を選択できるようになります。

property_exists() 関数の構文

property_exists()関数は、オブジェクトやクラスに指定したプロパティが定義されているかどうかをチェックします。構文は以下の通りです。

property_exists( mixed $class , string $property )

使用例：

if (property_exists($object, 'a_property'))

この関数は、プロパティの値がnullであっても、クラス内で定義されていればtrueを返す点が特徴です。

isset() 関数の構文

isset()関数は、変数がセットされていて、かつnullでないかどうかを判定します。構文は以下の通りです。

isset( mixed $var [, mixed $... ] )

使用例：

if (isset($object->a_property))

注意点として、プロパティ「a_property」の値がnullである場合、isset()はfalseを返します。つまり、プロパティが存在しても値がnullなら「存在しない」と判断されるため、この挙動の違いを実装時に意識することが重要です。

実際の使用例

property_exists()関数の具体的な動作を見てみましょう。

<?php
    class Demo {
        public $one;
        private $two;
        static protected $VAL;
        static function VAL() {
            var_dump(property_exists('myClass', 'two'));
        }
    }
    var_dump(property_exists('Demo', 'one'));
    var_dump(property_exists(new Demo, 'one'));
?>

出力結果

上記のコードを実行すると、次のような出力が得られます。

bool(true)
bool(true)

この例からわかるように、property_exists()はクラス名を文字列で指定した場合でも、インスタンスを渡した場合でも、同様にプロパティの存在を確認できることが確認できます。privateやprotectedなど、アクセス修飾子に関係なくプロパティの定義有無を判定したい場合に特に便利です。