クラスのデフォルトプロパティを取得する

# get_class_vars

(PHP 4, PHP 5, PHP 7, PHP 8)

get_class_vars — クラスのデフォルトプロパティを取得する

### 説明

function get_class_vars(string `$class`): array

指定したクラスのデフォルトプロパティを取得します。

### パラメータ

`class`

  クラス名。

### 戻り値

宣言されているプロパティのうち、現在のスコープから見えるものとそのデフォルト値を連想配列で返します。 返される配列要素は、`変数名 => 値` の形式となります。 エラーが発生した場合は `false` を返します。

### 例

例1 get_class_vars() の例

    <?php

    class MyClass
    {
        public $var1; // この変数にはデフォルト値がありません (技術的には、デフォルト値としてNULLが入っています)...
        public $var2 = "xyz";
        public $var3 = 100;
        private $var4;

        public function __construct()
        {
            // いくつかのプロパティを変更する
            $this->var1 = "foo";
            $this->var2 = "bar";
            return true;
        }
    }

    $my_class = new MyClass();

    $class_vars = get_class_vars(get_class($my_class));

    foreach ($class_vars as $name => $value) {
        echo "{$name}: ", var_export($value, true), "\n";
    }

    ?>

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

    var1: NULL
    var2: 'xyz'
    var3: 100

例2 get_class_vars() でのスコープの挙動

    <?php

    function format($array)
    {
        return implode('|', array_keys($array)) . "\r\n";
    }

    class TestCase
    {
        public $a    = 1;
        protected $b = 2;
        private $c   = 3;

        public static function expose()
        {
            echo format(get_class_vars(__CLASS__));
        }
    }

    TestCase::expose();
    echo format(get_class_vars('TestCase'));

    ?>

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

    // 5.0.0
    a| * b| TestCase c
    a| * b| TestCase c

    // 5.0.1 - 5.0.2
    a|b|c
    a|b|c

    // 5.0.3 +
    a|b|c
    a

### 参考

- get_class_methods() - クラスメソッドの名前を取得する
- get_object_vars() - 指定したオブジェクトのプロパティを取得する

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open