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

Copy
1<?php
2
3/**
4 * MyFileInfoクラスは、FilesystemIteratorによって返される
5 * ファイル情報オブジェクトのカスタムクラスです。
6 * SplFileInfoを継承する必要があります。
7 */
8class MyFileInfo extends SplFileInfo
9{
10    /**
11     * カスタムメソッドを追加することも可能ですが、
12     * この例ではクラスの変更を示すためにのみ使用します。
13     */
14    public function getCustomGreeting(): string
15    {
16        return "Hello from MyFileInfo for " . $this->getFilename();
17    }
18}
19
20/**
21 * setInfoClassメソッドの動作を実演する関数。
22 * FilesystemIteratorが返すSplFileInfoオブジェクトのクラスを変更します。
23 */
24function demonstrateSetInfoClass(): void
25{
26    // 一時ディレクトリとファイルをセットアップ
27    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_fs_iterator_test';
28    if (!file_exists($tempDir)) {
29        mkdir($tempDir);
30    }
31    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file1.txt', 'test content 1');
32    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file2.txt', 'test content 2');
33
34    echo "--- FilesystemIterator のデフォルト動作 ---\n";
35
36    // FilesystemIteratorをインスタンス化
37    $iterator = new FilesystemIterator($tempDir);
38
39    // デフォルトのクラスを確認 (SplFileInfo)
40    foreach ($iterator as $file) {
41        echo "デフォルトのファイル情報オブジェクトのクラス: " . get_class($file) . "\n";
42        // デモンストレーションのため、最初のファイルで終了
43        break;
44    }
45
46    echo "\n--- FilesystemIterator でカスタムクラスを設定後 ---\n";
47
48    // setInfoClass() を使ってカスタムクラスを設定
49    // FilesystemIterator::setInfoClass() は自身を返すため、メソッドチェーンも可能
50    $iterator->setInfoClass(MyFileInfo::class);
51
52    // カスタムクラスが適用されたかを確認
53    foreach ($iterator as $file) {
54        echo "カスタム設定後のファイル情報オブジェクトのクラス: " . get_class($file) . "\n";
55        // MyFileInfoクラスのカスタムメソッドを呼び出す例
56        echo $file->getCustomGreeting() . "\n";
57        // デモンストレーションのため、最初のファイルで終了
58        break;
59    }
60
61    // クリーンアップ
62    array_map('unlink', glob($tempDir . DIRECTORY_SEPARATOR . '*'));
63    rmdir($tempDir);
64}
65
66// 関数を実行
67demonstrateSetInfoClass();
68

PHPのFilesystemIterator::setInfoClassメソッドは、FilesystemIteratorがディレクトリ内のファイルを順番に処理する際に、それぞれのファイルの詳細情報（ファイル名、パス、サイズなど）を格納して返すオブジェクトのクラス（型）を指定する機能です。通常、FilesystemIteratorはファイル情報をSplFileInfoクラスのオブジェクトとして返しますが、このメソッドを使うことで、独自のカスタムクラスを設定できます。

引数$classNameには、新しいファイル情報オブジェクトとして使用したいクラス名を文字列で指定します。このカスタムクラスは、PHP標準のSplFileInfoクラスを必ず継承している必要があります。これにより、SplFileInfoが提供する基本的なファイル情報に加え、カスタムクラスで独自のメソッドやプロパティを追加し、より高度な処理を組み込めるようになります。このメソッドの戻り値はFilesystemIteratorオブジェクト自身なので、メソッドチェーンを使って続けて設定を行うことも可能です。

サンプルコードでは、FilesystemIteratorが初期状態で返すオブジェクトのクラスがSplFileInfoであることをget_class()関数で確認しています。その後、SplFileInfoを継承したMyFileInfoというカスタムクラスを定義し、setInfoClass()を使ってMyFileInfo::classを設定しています。再度ファイルを走査すると、返されるオブジェクトのクラスがMyFileInfoに変更されており、このカスタムクラスに実装された独自のgetCustomGreeting()メソッドが呼び出せる様子が示されています。これにより、ファイル情報オブジェクトを柔軟に拡張できることが理解できます。

Copy
1<?php
2
3/**
4 * SplFileInfoを継承したカスタムクラス。
5 * FilesystemIterator::setInfoClass()で使用し、ファイルに関する追加情報を提供します。
6 */
7class CustomFileInfo extends SplFileInfo
8{
9    /**
10     * コンストラクタは親クラスのコンストラクタを呼び出します。
11     *
12     * @param string $filename ファイルのパス
13     */
14    public function __construct(string $filename)
15    {
16        parent::__construct($filename);
17    }
18
19    /**
20     * カスタムのファイル情報を返します。
21     * このメソッドは、FilesystemIteratorが返すオブジェクトがCustomFileInfoのインスタンスである場合にのみ利用可能です。
22     *
23     * @return string ファイル名を含むカスタム情報
24     */
25    public function getCustomMessage(): string
26    {
27        return 'Custom message for file: ' . $this->getFilename() . ' (Path: ' . $this->getPathname() . ')';
28    }
29}
30
31// 単体で動作可能なコードとするため、一時的なテストディレクトリとファイルを作成します。
32$testDir = __DIR__ . '/_temp_filesystem_test';
33if (!is_dir($testDir)) {
34    mkdir($testDir);
35}
36file_put_contents($testDir . '/report.txt', 'This is a test report.');
37file_put_contents($testDir . '/data.log', 'Log entry: System started.');
38
39try {
40    // FilesystemIteratorのインスタンスを作成します。
41    // SKIP_DOTS: .と..をスキップする
42    // CURRENT_AS_FILEINFO: イテレーション中にSplFileInfoオブジェクトを返すように設定
43    $iterator = new FilesystemIterator(
44        $testDir,
45        FilesystemIterator::SKIP_DOTS | FilesystemIterator::CURRENT_AS_FILEINFO
46    );
47
48    // FilesystemIterator::setInfoClass() メソッドを使用して、
49    // イテレータがループ中に返すオブジェクトのクラスをCustomFileInfoに変更します。
50    // CustomFileInfo::class は、クラス名を文字列として取得するためのPHPの定数です。
51    $iterator->setInfoClass(CustomFileInfo::class);
52
53    echo "--- CustomFileInfoオブジェクトとしてファイル情報を取得 ---\n";
54    foreach ($iterator as $file) {
55        // $file は CustomFileInfo クラスのインスタンスになります。
56        echo "ファイル名: " . $file->getFilename() . "\n";
57        echo "クラス名: " . get_class($file) . "\n";
58        echo "カスタムメッセージ: " . $file->getCustomMessage() . "\n"; // CustomFileInfoのカスタムメソッドを呼び出し
59        echo "--------------------------------------------------------\n";
60    }
61
62    // setInfoClass() に null を渡すことで、デフォルトの SplFileInfo オブジェクトに戻すこともできます。
63    $iterator->setInfoClass(null);
64
65    echo "\n--- デフォルトのSplFileInfoオブジェクトとしてファイル情報を取得 ---\n";
66    foreach ($iterator as $file) {
67        // $file は SplFileInfo クラスのインスタンスに戻ります。
68        echo "ファイル名: " . $file->getFilename() . "\n";
69        echo "クラス名: " . get_class($file) . "\n";
70        // ここでは CustomFileInfo のカスタムメソッドは呼び出せません。
71        // echo "カスタムメッセージ: " . $file->getCustomMessage() . "\n"; // この行はエラーになります
72        echo "--------------------------------------------------------\n";
73    }
74
75} catch (UnexpectedValueException $e) {
76    // ディレクトリが存在しないなどのエラーが発生した場合の処理
77    echo "エラーが発生しました: " . $e->getMessage() . "\n";
78} finally {
79    // 後処理: テストで作成したディレクトリとファイルを削除します。
80    if (is_dir($testDir)) {
81        $files = glob($testDir . '/*');
82        if (is_array($files)) {
83            foreach ($files as $file) {
84                if (is_file($file)) {
85                    unlink($file);
86                }
87            }
88        }
89        rmdir($testDir);
90    }
91}

PHPのFilesystemIterator::setInfoClassメソッドは、ディレクトリ内のファイル情報を取得する際に、その情報を持つオブジェクトの型を開発者が指定したカスタムクラスに変更できる機能を提供します。通常、FilesystemIteratorは各ファイルの情報をSplFileInfoという標準のオブジェクトで返しますが、このメソッドを使うことで、独自の追加機能を持つクラスのインスタンスを返させることが可能になります。

引数$classNameには、SplFileInfoを継承したカスタムクラスのクラス名を文字列で渡します。CustomFileInfo::classのように指定することで、PHPの定数としてクラス名を取得できます。もしnullを渡すと、オブジェクトの型はデフォルトのSplFileInfoに戻ります。このメソッドはFilesystemIterator自身のインスタンスを返すため、メソッドチェーンで他の設定も続けて行えます。

サンプルコードでは、CustomFileInfoというSplFileInfoを継承したクラスを定義し、独自のgetCustomMessageメソッドを追加しています。FilesystemIteratorを初期化した後、setInfoClass(CustomFileInfo::class)を呼び出すことで、イテレータがループ中に返すファイル情報オブジェクトがCustomFileInfoのインスタンスになります。これにより、CustomFileInfoで定義したgetCustomMessageのようなカスタムメソッドを呼び出すことができるようになります。その後、setInfoClass(null)でデフォルトに戻し、違いを確認しています。これは、ファイル情報をより柔軟に扱いたい場合に非常に便利です。