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

Copy
1<?php
2
3/**
4 * このスクリプトは、PHPのSplFileInfoクラスにおけるマジックメソッド
5 * `__debugInfo()` の動作を示します。
6 *
7 * `__debugInfo()` は、`var_dump()` のようなデバッグ関数がオブジェクトに
8 * 使用された際に、そのオブジェクトのデバッグ出力をカスタマイズするために
9 * 内部的に呼び出される特殊なメソッドです。
10 *
11 * SplFileInfoはPHPの組み込みファイナルクラスであり、このメソッドを
12 * 直接オーバーライドすることはできません。しかし、`var_dump()` を使用して
13 * SplFileInfoオブジェクトを調べると、その内部的な `__debugInfo()` メソッドが
14 * どのように動作し、デバッグ情報を整形して表示しているかを観察できます。
15 */
16
17// 1. デモンストレーション用のダミーファイルを作成します。
18// これは、SplFileInfoオブジェクトがファイル情報にアクセスできるようにするためです。
19$fileName = 'debug_info_sample.txt';
20file_put_contents($fileName, 'これはデバッグ情報を示すためのサンプルファイルです。');
21
22// 2. SplFileInfoオブジェクトをインスタンス化します。
23// SplFileInfoは、ファイルやディレクトリのパスを受け取り、それに関する
24// 様々な情報（ファイル名、サイズ、権限など）をオブジェクト指向で提供します。
25$fileInfo = new SplFileInfo($fileName);
26
27echo "--- SplFileInfoオブジェクトの var_dump() 出力 ---\n";
28
29// 3. SplFileInfoオブジェクトに対して var_dump() を実行します。
30// var_dump() がオブジェクトに適用されると、PHPは内部的にそのクラスの
31// __debugInfo() メソッド（もし定義されていれば）を呼び出します。
32// SplFileInfoには、ファイルに関する詳細なデバッグ情報を提供する
33// 独自の内部的な __debugInfo() の実装があります。
34// そのメソッドが返す配列の内容が、var_dump() の出力として整形されて表示されます。
35var_dump($fileInfo);
36
37// 4. デモンストレーション後に作成したダミーファイルを削除してクリーンアップします。
38unlink($fileName);
39
40// var_dump() の出力で表示される 'object(SplFileInfo)' の内容は、
41// SplFileInfo::__debugInfo() メソッドが動的に生成し、返した配列に基づいています。
42// この機能により、開発者はオブジェクトの内部状態をデバッグ時に見やすくカスタマイズできます。

このサンプルコードは、PHPのSplFileInfoクラスにおけるマジックメソッド__debugInfo()の動作を示します。SplFileInfoは、ファイルやディレクトリの様々な情報を簡単に取得・操作できるクラスです。__debugInfo()メソッドは、var_dump()のようなデバッグ関数がオブジェクトに対して実行された際に、そのオブジェクトのデバッグ出力をカスタマイズするためにPHPが内部的に呼び出す特別なメソッドです。

このメソッドは引数を受け取らず、デバッグ表示のために整形された情報を含む配列を返します。SplFileInfoクラスでは、この__debugInfo()が内部的に実装されており、ファイル名、パス、サイズ、アクセス権限といったファイルに関する詳細な情報を整理して提供します。

サンプルコードでは、一時的なダミーファイルを作成し、そのファイルパスからSplFileInfoオブジェクトを生成しています。そして、生成した$fileInfoオブジェクトをvar_dump()で出力することで、SplFileInfoクラスの内部的な__debugInfo()メソッドが自動的に呼び出され、ファイルに関する分かりやすいデバッグ情報が整形されて表示される様子を確認できます。これにより、開発者はオブジェクトの内部状態を効率的に把握できます。

Copy
1<?php
2
3// 一時的なファイルを作成し、SplFileInfoオブジェクトで扱う準備をします。
4$tempFileName = 'debug_info_test.txt';
5file_put_contents($tempFileName, 'これはデバッグ情報テスト用のファイルです。');
6
7/**
8 * SplFileInfo を継承し、__debugInfo マジックメソッドを実装したカスタムクラス。
9 *
10 * __debugInfo は、オブジェクトが var_dump() されたときに表示される情報を
11 * カスタマイズするために使用されるマジックメソッドです。
12 * これにより、オブジェクトの内部構造をより分かりやすく、または必要な情報のみに
13 * 絞って表示させることができます。
14 */
15class CustomSplFileInfo extends SplFileInfo
16{
17    private string $customDescription;
18
19    /**
20     * コンストラクタ。
21     *
22     * @param string $filename ファイルパス。
23     * @param string $customDescription デバッグ情報に追加するカスタム記述。
24     */
25    public function __construct(string $filename, string $customDescription = '特別なファイル情報')
26    {
27        parent::__construct($filename);
28        $this->customDescription = $customDescription;
29    }
30
31    /**
32     * オブジェクトが var_dump() されたときに呼び出されます。
33     *
34     * このメソッドは配列を返します。返された配列のキーと値が、
35     * var_dump() の出力としてオブジェクトのプロパティのように表示されます。
36     *
37     * @return array デバッグ情報として表示されるキーと値のペア。
38     */
39    public function __debugInfo(): array
40    {
41        // 親クラス (SplFileInfo) の持つ情報を利用しつつ、
42        // カスタムのプロパティや計算結果を追加して返します。
43        return [
44            'filePath'         => $this->getPathname(),           // ファイルのフルパス
45            'fileName'         => $this->getBasename(),           // ファイル名のみ
46            'fileSize'         => $this->getSize() . ' bytes',    // ファイルサイズ
47            'lastModifiedTime' => date('Y-m-d H:i:s', $this->getMTime()), // 最終更新日時を整形
48            'customDescription' => $this->customDescription,      // このクラス独自のプロパティ
49            'isReadable'       => $this->isReadable() ? 'Yes' : 'No', // 読み取り可能かどうかの情報
50        ];
51    }
52}
53
54// CustomSplFileInfo クラスのインスタンスを作成します。
55$fileInfo = new CustomSplFileInfo($tempFileName, 'これは重要な設定ファイルです');
56
57// var_dump() を使用して、オブジェクトのデバッグ情報を表示します。
58// ここで __debugInfo マジックメソッドが呼び出され、カスタマイズされた情報が表示されます。
59echo "--- CustomSplFileInfo オブジェクトの var_dump() 出力 ---\n";
60var_dump($fileInfo);
61
62// 通常のオブジェクトプロパティへのアクセスは、__debugInfo の影響を受けません。
63echo "\n--- 通常のメソッド呼び出しの例 ---\n";
64echo "ファイル名: " . $fileInfo->getBasename() . "\n";
65echo "ファイルサイズ: " . $fileInfo->getSize() . " bytes\n";
66echo "カスタム記述 (privateプロパティに直接アクセスできないため、__debugInfoがなければvar_dumpには表示されない): N/A (private)\n";
67
68
69// 使用した一時ファイルをクリーンアップします。
70unlink($tempFileName);
71
72?>

__debugInfoは、PHPのオブジェクトがvar_dump()などのデバッグ関数で出力される際に、表示される情報をカスタマイズするための特別なマジックメソッドです。このメソッドは引数を取らず、連想配列を返します。この配列のキーと値が、var_dump()の出力においてオブジェクトのプロパティであるかのように表示されます。

サンプルコードでは、SplFileInfoクラスを継承したCustomSplFileInfoクラスを作成し、__debugInfoメソッドを実装しています。通常、SplFileInfoオブジェクトをvar_dump()すると、内部のプライベートなプロパティなど、少し分かりにくい情報が表示されることがあります。しかし、このカスタムクラスでは__debugInfoメソッド内で、ファイルのフルパス、ファイル名、サイズ、最終更新日時、さらにクラス独自のカスタム記述など、人間にとって理解しやすい情報を整形して配列として返しています。

これにより、$fileInfoオブジェクトをvar_dump()で出力すると、定義した__debugInfoメソッドが呼び出され、カスタマイズされた分かりやすいデバッグ情報が表示されます。複雑なオブジェクトのデバッグ時に、必要な情報だけを簡潔に表示させたい場合に非常に役立つ機能です。