【PHP8.x】get_object_vars関数の使い方

Copy
1<?php
2
3/**
4 * 親クラスを定義します。
5 * 各アクセス修飾子を持つプロパティを含みます。
6 */
7class ParentClass
8{
9    public string $parentPublicProperty = '親クラスの公開プロパティ';
10    protected string $parentProtectedProperty = '親クラスの保護プロパティ';
11    private string $parentPrivateProperty = '親クラスの非公開プロパティ';
12}
13
14/**
15 * ParentClass を継承する子クラスを定義します。
16 * 子クラス独自のプロパティも持ちます。
17 */
18class ChildClass extends ParentClass
19{
20    public string $childPublicProperty = '子クラスの公開プロパティ';
21    protected string $childProtectedProperty = '子クラスの保護プロパティ';
22    private string $childPrivateProperty = '子クラスの非公開プロパティ';
23}
24
25// ChildClass のオブジェクトを作成します。
26$childObject = new ChildClass();
27
28// get_object_vars() 関数を使用して、オブジェクトの公開プロパティをすべて取得します。
29// この関数は、指定されたオブジェクトが持つ「公開 (public)」なプロパティのみを
30// 連想配列として返します。
31// 親クラスから継承された公開プロパティも含まれますが、
32// protected や private なプロパティは結果に含まれません。
33$properties = get_object_vars($childObject);
34
35// 取得したプロパティ配列の内容を表示します。
36// 結果には 'parentPublicProperty' と 'childPublicProperty' のみが含まれていることがわかります。
37print_r($properties);
38
39?>

PHPのget_object_vars関数は、指定されたオブジェクトが持つ「公開 (public)」なプロパティをすべて取得するための関数です。この関数は引数としてobject型のオブジェクトを受け取り、プロパティ名とその値のペアを要素とする連想配列をarray型で返します。

提供されたサンプルコードでは、ParentClassとその子クラスであるChildClassが定義されており、それぞれに公開、保護、非公開のプロパティが含まれています。ChildClassのオブジェクトを作成し、get_object_vars関数に渡すことで、そのオブジェクトのプロパティを取得しています。

重要な点として、get_object_varsは、たとえ継承関係にあるクラスのオブジェクトであっても、そのオブジェクトから直接アクセス可能な「公開 (public)」なプロパティのみを返します。親クラスから継承された公開プロパティも結果に含まれますが、protected（保護された）やprivate（非公開の）プロパティは、この関数では取得されません。したがって、サンプルコードの実行結果には、parentPublicPropertyとchildPublicPropertyのみが含まれることが確認できます。この関数は、オブジェクトの外部から参照可能な情報のみを抽出したい場合に特に役立ちます。

Copy
1<?php
2
3// get_object_vars 関数は、オブジェクトが持つ 'public' なプロパティのみを連想配列として返します。
4// 'protected' や 'private' なプロパティは含まれません。
5// そのため、もしオブジェクトに public なプロパティが一つもなければ、この関数は空の配列を返します。
6
7/**
8 * このクラスは private および protected なプロパティのみを持ち、
9 * public なプロパティは一切持ちません。
10 */
11class ConfigurationStore
12{
13    private string $databasePassword = 'super_secret_password_123';
14    protected array $internalSettings = [
15        'debugMode' => false,
16        'logLevel' => 'info'
17    ];
18
19    public function __construct(string $dbPass)
20    {
21        $this->databasePassword = $dbPass;
22    }
23
24    // public なプロパティは定義されていません。
25}
26
27// ConfigurationStore クラスのインスタンスを作成します。
28$config = new ConfigurationStore('my_secure_db_pass');
29
30// get_object_vars 関数を使用して、インスタンスの public プロパティを取得します。
31// ConfigurationStore クラスには public なプロパティがないため、空の配列が返されるはずです。
32$properties = get_object_vars($config);
33
34echo "ConfigurationStore インスタンスの public プロパティ:\n";
35var_dump($properties);
36
37// 結果が空の配列であることを確認し、その理由を説明します。
38if (empty($properties)) {
39    echo "\nget_object_vars 関数は、ConfigurationStore オブジェクトに public なプロパティがないため、空の配列を返しました。\n";
40}
41

PHPのget_object_vars関数は、指定されたオブジェクトが持つすべてのpublicなプロパティを連想配列として取得する際に使用します。引数には取得対象のobject（オブジェクトインスタンス）を指定し、戻り値はプロパティ名がキー、その値がバリューとなるarray（連想配列）です。この関数は、privateやprotectedなプロパティは戻り値の配列には含まれません。

上記のサンプルコードでは、ConfigurationStoreというクラスが定義されています。このクラスはprivateな$databasePasswordとprotectedな$internalSettingsというプロパティを持ちますが、publicなプロパティは一切持っていません。

そのため、ConfigurationStoreクラスのインスタンスを作成し、それをget_object_vars関数に渡してプロパティを取得しようとすると、結果は空の配列となります。これは、get_object_vars関数が参照できるpublicなプロパティがオブジェクト内に存在しないためです。このように、この関数はpublicなプロパティのみを対象とするため、もしオブジェクトにpublicプロパティが一つもなければ、空の配列が返されるという挙動を理解しておくことが重要です。

Copy
1<?php
2
3/**
4 * オブジェクトのプロパティの可視性と、
5 * get_object_vars() および (array) キャストの挙動を比較するサンプルコード。
6 */
7class PropertyVisibilityExample
8{
9    public string $publicProperty = "これは公開プロパティです。";
10    protected string $protectedProperty = "これは保護プロパティです。";
11    private string $privateProperty = "これは非公開プロパティです。";
12
13    // コンストラクタはプロパティの初期化のみのため、特に処理は記述しません。
14    public function __construct()
15    {
16        // プロパティは宣言時にデフォルト値で初期化されます。
17    }
18}
19
20// クラスのインスタンスを作成します。
21$object = new PropertyVisibilityExample();
22
23echo "--- get_object_vars() の結果 ---" . PHP_EOL;
24// get_object_vars() は、オブジェクトの外部からアクセス可能な (public) プロパティのみを
25// 連想配列として返します。protected や private プロパティは含まれません。
26$vars = get_object_vars($object);
27print_r($vars);
28echo PHP_EOL;
29
30echo "--- (array) キャストの結果 ---" . PHP_EOL;
31// オブジェクトを (array) にキャストすると、オブジェクトの全てのプロパティが配列に含まれます。
32// ただし、protected プロパティのキーには '\0*\0' が、
33// private プロパティのキーには '\0ClassName\0' (ClassNameはクラス名) がプレフィックスとして付加されます。
34$castedArray = (array) $object;
35print_r($castedArray);
36echo PHP_EOL;
37
38echo "--- 結果のまとめ ---" . PHP_EOL;
39echo "get_object_vars():" . PHP_EOL;
40echo "  - オブジェクトのpublicプロパティのみを返します。" . PHP_EOL;
41echo "  - キーはプロパティ名そのままです。" . PHP_EOL;
42echo "(array) キャスト:" . PHP_EOL;
43echo "  - オブジェクトのpublic, protected, private全てのプロパティを返します。" . PHP_EOL;
44echo "  - protected/privateプロパティのキーには、特別な形式のプレフィックスが付与されます。" . PHP_EOL;
45
46?>

get_object_vars関数は、PHP 8.4.12でオブジェクトのpublicなプロパティを連想配列として取得するために使用します。引数にはオブジェクト$objectを指定します。戻り値は配列で、オブジェクトのpublicプロパティ名がキー、プロパティの値が値となります。

このサンプルコードでは、get_object_varsと(array)キャストの挙動の違いを比較します。PropertyVisibilityExampleクラスは、public、protected、privateの異なる可視性を持つプロパティを定義しています。

get_object_vars($object)は、$objectのpublicプロパティ（$publicProperty）のみを含む連想配列を返します。protectedやprivateプロパティは結果に含まれません。

一方、(array) $objectは、オブジェクトの全てのプロパティを配列として返します。ただし、protectedプロパティのキーには\0*\0が、privateプロパティのキーには\0ClassName\0（ClassNameはクラス名）がプレフィックスとして付加されます。これにより、protectedやprivateプロパティを区別できます。

get_object_varsはpublicプロパティのみを扱い、キーはプロパティ名そのままです。(array)キャストは全てのプロパティを返しますが、protected/privateプロパティのキーには特別なプレフィックスが付与されます。どちらの方法を使用するかは、必要なプロパティの種類や、アクセス制御の要件によって選択します。