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

Copy
1<?php
2
3// --------------------------------------------------------------------------------
4// FilesystemIterator::__debugInfo メソッドの動作を示すサンプルコード
5// このマジックメソッドは、var_dump() や print_r() のようなデバッグ関数がオブジェクトの情報を
6// 表示する際に、その出力内容をカスタマイズするためにPHP内部で呼び出されます。
7// 開発者が明示的に呼び出すことはありません。
8// --------------------------------------------------------------------------------
9
10// 1. 一時ディレクトリとダミーファイルを作成します。
11//    FilesystemIterator が実際に操作する対象を用意するためです。
12$tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . uniqid('php_fsi_debug_');
13if (!mkdir($tempDir) && !is_dir($tempDir)) {
14    throw new RuntimeException(sprintf('Directory "%s" was not created', $tempDir));
15}
16file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file1.txt', 'Hello from file1');
17file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file2.txt', 'Hello from file2');
18if (!mkdir($tempDir . DIRECTORY_SEPARATOR . 'subdir') && !is_dir($tempDir . DIRECTORY_SEPARATOR . 'subdir')) {
19    throw new RuntimeException(sprintf('Directory "%s" was not created', $tempDir . DIRECTORY_SEPARATOR . 'subdir'));
20}
21file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'subdir' . DIRECTORY_SEPARATOR . 'subfile.txt', 'Hello from subfile');
22
23echo "--- FilesystemIterator の初期デバッグ情報 ---" . PHP_EOL;
24
25try {
26    // 2. FilesystemIterator のインスタンスを作成します。
27    //    指定されたディレクトリ ($tempDir) 内のファイルやディレクトリを走査します。
28    //    フラグ (FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO)
29    //    は、イテレータのキーをパス名、現在値を SplFileInfo オブジェクトとして扱うことを指定します。
30    $iterator = new FilesystemIterator(
31        $tempDir,
32        FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO
33    );
34
35    // 3. var_dump() 関数を使ってオブジェクトの内部状態を表示します。
36    //    このとき、PHPは FilesystemIterator の __debugInfo() マジックメソッドを内部的に呼び出し、
37    //    その結果（配列）を元にデバッグ出力を整形して表示します。
38    var_dump($iterator);
39
40    echo PHP_EOL . "--- イテレータを一つ進めた後のデバッグ情報 ---" . PHP_EOL;
41    // 4. イテレータを最初に巻き戻し、次の要素へ進めます。
42    $iterator->rewind();
43    $iterator->next();
44    // 5. 再び var_dump() を使用して、イテレータの状態変化を確認します。
45    //    __debugInfo() はイテレータの現在の位置なども含んだ情報を返します。
46    var_dump($iterator);
47
48} catch (Exception $e) {
49    echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
50} finally {
51    // 6. 後処理として、作成した一時ファイルとディレクトリを再帰的に削除します。
52    //    rmdir() 関数は空のディレクトリしか削除できないため、再帰的に削除する補助関数が必要です。
53    function rrmdir(string $dir): void
54    {
55        if (!is_dir($dir)) {
56            return;
57        }
58        $files = array_diff(scandir($dir), ['.', '..']);
59        foreach ($files as $file) {
60            (is_dir("$dir/$file")) ? rrmdir("$dir/$file") : unlink("$dir/$file");
61        }
62        rmdir($dir);
63    }
64    rrmdir($tempDir);
65    echo PHP_EOL . "一時ディレクトリとファイルが削除されました。" . PHP_EOL;
66}

PHPのFilesystemIterator::__debugInfoメソッドは、オブジェクトのデバッグ情報をカスタマイズするためにPHP内部で呼び出される特殊な「マジックメソッド」です。このメソッドは開発者が直接呼び出すものではなく、var_dump()やprint_r()といったデバッグ関数がFilesystemIteratorのインスタンスを検査する際に、PHPが自動的に実行します。

__debugInfoメソッドは引数を取りません。戻り値として、オブジェクトのデバッグ情報を表現する連想配列を返します。この配列の内容が、var_dump()などのデバッグ出力として整形されて表示されるため、FilesystemIteratorのような複雑なオブジェクトの内部状態を、より分かりやすく、また必要な情報に絞って確認できるようになります。

サンプルコードでは、FilesystemIteratorのインスタンスを生成し、var_dump()でその時点のデバッグ情報を表示しています。その後、イテレータを一つ進めてから再度var_dump()を実行することで、__debugInfoがイテレータの現在の位置などの状態変化をどのようにデバッグ情報として提供し、出力に反映させるかを確認できます。これにより、開発者はFilesystemIteratorの実行時における詳細な状態を効果的に把握することができます。

Copy
1<?php
2
3// 1. 一時ディレクトリとテストファイルを作成します。
4// これにより、FilesystemIterator が処理するための内容が用意されます。
5$tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'example_dir_' . uniqid();
6mkdir($tempDir, 0777, true); // ディレクトリを作成。第三引数trueで再帰的に作成。
7file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file1.txt', 'This is file 1 content.');
8file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file2.txt', 'This is file 2 content.');
9
10echo "一時ディレクトリを作成しました: " . $tempDir . "\n";
11echo "その中に 'file1.txt' と 'file2.txt' を作成しました。\n\n";
12
13try {
14    // 2. FilesystemIterator のインスタンスを作成します。
15    // FilesystemIterator::SKIP_DOTS フラグは、'.' と '..' (現在のディレクトリと親ディレクトリ) をスキップします。
16    $iterator = new FilesystemIterator($tempDir, FilesystemIterator::SKIP_DOTS);
17
18    echo "FilesystemIterator オブジェクトを初期化しました。\n";
19    echo "var_dump() を使って、オブジェクトのデバッグ情報を表示します。\n";
20    echo "__debugInfo メソッドは、var_dump() のようにオブジェクトの内容を表示する際に内部的に呼び出され、\n";
21    echo "オブジェクトのデバッグ表現をカスタマイズするために使用されます。\n\n";
22
23    // 3. 最初の状態での FilesystemIterator オブジェクトのデバッグ情報を表示します。
24    // var_dump() が呼び出されると、PHPは内部的に FilesystemIterator クラスの __debugInfo メソッドを呼び出し、
25    // その戻り値（配列）に基づいてオブジェクトの情報を整形して表示します。
26    echo "--- 最初の状態の FilesystemIterator オブジェクト ---\n";
27    var_dump($iterator);
28
29    // 4. イテレータを1つ進めます。
30    // next() メソッドを呼び出すと、イテレータは次のファイルに移動します。
31    // その後、再度 var_dump() で状態の変化を確認します。
32    $iterator->next();
33    echo "\n--- next() を呼び出した後の FilesystemIterator オブジェクト ---\n";
34    var_dump($iterator);
35
36} finally {
37    // 5. クリーンアップ処理: 作成した一時ディレクトリとファイルを削除します。
38    // プログラムの実行後に不要なファイルが残らないようにします。
39    foreach (new FilesystemIterator($tempDir, FilesystemIterator::SKIP_DOTS) as $file) {
40        unlink($file->getPathname()); // ファイルを削除
41    }
42    rmdir($tempDir); // ディレクトリを削除
43    echo "\n一時ディレクトリとファイルをクリーンアップしました。\n";
44}

PHP 8のFilesystemIteratorクラスに属する__debugInfoメソッドは、デバッグ時にオブジェクトの内部情報をカスタマイズして表示するための特別なメソッドです。このメソッドは引数を一切取らず、戻り値としてarray型を返します。var_dump()関数などを利用してオブジェクトの内容を確認しようとすると、PHPは内部的にこの__debugInfoメソッドを自動で呼び出します。メソッドが返す配列は、var_dump()がオブジェクトの構造や現在の状態を整形して出力する際に利用され、開発者にとって理解しやすい形でデバッグ情報を提供します。

サンプルコードでは、一時ディレクトリ内のファイルを扱うFilesystemIteratorオブジェクトを作成しています。最初のvar_dump($iterator)の呼び出しでは、__debugInfoメソッドが実行され、イテレータの初期状態（例えば、まだファイルを指していない状態）がデバッグ情報として表示されます。その後、$iterator->next()でイテレータを次のファイルに進めてから再度var_dump($iterator)を呼び出すと、再び__debugInfoが起動し、イテレータの現在位置が変化した状態がデバッグ情報に反映されて表示されます。このように、__debugInfoメソッドはオブジェクトの動的な状態をデバッグ時に視覚的に把握するのに役立ちます。