【PHP8.x】RecursiveArrayIterator::__debugInfo()メソッドの使い方

Copy
1<?php
2
3/**
4 * RecursiveArrayIterator を継承し、__debugInfo をオーバーライドして
5 * デバッグ情報をカスタマイズするクラス。
6 *
7 * システムエンジニアを目指す初心者の方へ:
8 * __debugInfo メソッドは、var_dump() のようなデバッグ関数がオブジェクトの内容を表示する際に、
9 * どのような情報を表示するかを自分で定義するための特別なメソッドです。
10 * これにより、オブジェクトの内部構造が複雑な場合でも、
11 * デバッグ時に本当に必要な情報だけを簡潔に表示できるようになります。
12 */
13class CustomDebuggableRecursiveArrayIterator extends RecursiveArrayIterator
14{
15    private string $iteratorPurpose;
16
17    /**
18     * コンストラクタ。
19     *
20     * @param array  $array デバッグする多次元配列。
21     * @param string $purpose このイテレータの目的を示す文字列。
22     */
23    public function __construct(array $array, string $purpose = 'General Use')
24    {
25        parent::__construct($array);
26        $this->iteratorPurpose = $purpose;
27    }
28
29    /**
30     * var_dump() などのデバッグ関数がこのオブジェクトの内容を表示する際に呼び出されます。
31     * このメソッドは、デバッグ時に表示したい情報を連想配列として返します。
32     *
33     * @return array デバッグ時に表示する情報を含む連想配列。
34     */
35    public function __debugInfo(): array
36    {
37        // 親クラス (RecursiveArrayIterator) のデフォルトのデバッグ情報を取得します。
38        // これには、イテレータが保持する配列の内部状態などが含まれます。
39        $parentInfo = parent::__debugInfo();
40
41        // カスタム情報を追加したり、既存の情報を整形したりできます。
42        return [
43            'purpose' => $this->iteratorPurpose,           // このイテレータの目的
44            'currentKey' => $this->key(),                 // 現在指しているキー
45            'currentValue' => $this->current(),           // 現在指している値
46            'hasChildren' => $this->hasChildren(),        // 子要素があるか
47            'flags' => $this->getFlags(),                 // 設定されているフラグ
48            'internalArrayCount' => count($this->getArrayCopy()), // 内部配列の要素数
49            // 親クラスのデバッグ情報をそのまま含めることで、オリジナルの情報も確認できます。
50            // これにより、デフォルトのデバッグ情報とカスタム情報の両方を表示できます。
51            '__parent_recursive_array_iterator_info__' => $parentInfo,
52        ];
53    }
54}
55
56// デモ用の多次元配列を準備します。
57$sampleData = [
58    'fruits' => ['apple', 'banana', 'cherry'],
59    'vegetables' => ['carrot', 'potato', 'onion'],
60    'details' => [
61        'source' => 'local_db',
62        'last_updated' => '2023-10-27',
63    ],
64    'empty_category' => [],
65];
66
67// CustomDebuggableRecursiveArrayIterator のインスタンスを作成します。
68$myIterator = new CustomDebuggableRecursiveArrayIterator($sampleData, 'Product Categories Iterator');
69
70// var_dump() を使用して $myIterator のデバッグ情報を表示します。
71// __debugInfo メソッドが定義されているため、そのメソッドが返した内容が表示されます。
72echo "--- CustomDebuggableRecursiveArrayIterator の var_dump() 出力 ---\n";
73var_dump($myIterator);
74
75echo "\n--- 標準の RecursiveArrayIterator の var_dump() 出力 (比較用) ---\n";
76// 比較のために、標準の RecursiveArrayIterator のデバッグ情報も表示します。
77// こちらはPHPの内部で定義されたデフォルトの形式で表示されます。
78$standardIterator = new RecursiveArrayIterator($sampleData);
79var_dump($standardIterator);
80

PHPの__debugInfoメソッドは、オブジェクトをvar_dump()などのデバッグ関数で出力する際に、その表示内容をカスタマイズするための特別なメソッドです。RecursiveArrayIteratorのように内部構造が複雑なオブジェクトの場合、デフォルトのデバッグ情報だけでは内容を把握しにくいことがあります。このメソッドを実装することで、デバッグ時に本当に必要な情報だけを簡潔に表示できるようになります。

このサンプルコードでは、RecursiveArrayIteratorを継承したクラスを作成し、__debugInfoメソッドをオーバーライドしています。このメソッドは引数を受け取らず、デバッグ表示させたい情報をキーと値のペアで格納した連想配列を戻り値として返します。

オーバーライドされた__debugInfoメソッド内では、イテレータの目的や現在指している要素、子要素の有無など、カスタムで定義した情報を連想配列として生成しています。さらに、親クラスであるRecursiveArrayIteratorのデフォルトのデバッグ情報も取得し、カスタム情報と組み合わせて表示しています。これにより、オブジェクトのデバッグ出力に、より分かりやすく整理された情報を含めることができます。

最後にvar_dump()でこのオブジェクトを表示すると、定義した__debugInfoメソッドが自動的に呼び出され、メソッドが返した連想配列の内容がデバッグ情報として整形されて出力されます。これにより、標準の出力と比較して、必要な情報に絞ったデバッグが可能となることを確認できます。