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

Copy
1<?php
2
3/**
4 * カスタムファイルオブジェクトクラスを定義します。
5 * RecursiveDirectoryIterator::setFileClass() でこのクラスが使用されるように指定することで、
6 * ファイルを走査する際にこのカスタムオブジェクトのインスタンスが生成されます。
7 * SplFileObject を継承することで、ファイルに関する基本的な操作（例: getFilename(), getPathname()）を
8 * そのまま利用しつつ、独自の機能を追加できます。
9 */
10class CustomFileObject extends SplFileObject
11{
12    /**
13     * このファイルオブジェクトに関連付けられたカスタム情報を返します。
14     * システムエンジニアを目指す初心者の方へ：
15     * このメソッドは、標準の SplFileObject には存在しない、
16     * あなたが独自に追加した機能の例です。
17     *
18     * @return string ファイル名を含むカスタム情報
19     */
20    public function getCustomFileNameInfo(): string
21    {
22        return "ファイル名: " . $this->getFilename() . " (カスタムオブジェクト)";
23    }
24
25    /**
26     * このファイルオブジェクトがCustomFileObjectのインスタンスであるかを確認します。
27     *
28     * @return bool 常に true
29     */
30    public function isCustomObject(): bool
31    {
32        return true;
33    }
34}
35
36// --- 以下はサンプルコードを単体で動作させるための準備と実行ロジックです ---
37
38// テスト用のディレクトリとファイルを作成します。
39// このスクリプトと同じディレクトリ内に作成され、実行後にクリーンアップされます。
40$testDir = __DIR__ . '/test_dir_for_recursive';
41if (!is_dir($testDir)) {
42    mkdir($testDir, 0777, true);
43}
44file_put_contents($testDir . '/file1.txt', 'Hello, World!');
45file_put_contents($testDir . '/file2.log', 'Log entry.');
46if (!is_dir($testDir . '/subdir')) {
47    mkdir($testDir . '/subdir', 0777, true);
48}
49file_put_contents($testDir . '/subdir/file3.json', '{"key": "value"}');
50
51echo "ディレクトリ '" . basename($testDir) . "' のファイルを走査します。\n\n";
52
53try {
54    // RecursiveDirectoryIterator をインスタンス化し、走査するディレクトリを指定します。
55    $directoryIterator = new RecursiveDirectoryIterator($testDir);
56
57    // RecursiveDirectoryIterator::setFileClass() メソッドを使って、
58    // ファイルオブジェクトのクラスを 'CustomFileObject' に設定します。
59    // これにより、イテレータがファイルを処理する際に、SplFileObject ではなく
60    // CustomFileObject のインスタンスが生成されるようになります。
61    $directoryIterator->setFileClass('CustomFileObject');
62
63    // RecursiveIteratorIterator を使って、サブディレクトリも再帰的に走査できるようにします。
64    $iterator = new RecursiveIteratorIterator($directoryIterator);
65
66    // ディレクトリ内のすべてのファイルとディレクトリをループ処理します。
67    foreach ($iterator as $file) {
68        // ディレクトリはスキップし、ファイルのみを処理します。
69        if ($file->isFile()) {
70            echo "取得されたファイルオブジェクトのクラス名: " . get_class($file) . "\n";
71
72            // $file が CustomFileObject のインスタンスであることを確認し、
73            // そのカスタムメソッドを呼び出します。
74            if ($file instanceof CustomFileObject) {
75                echo "  " . $file->getCustomFileNameInfo() . "\n";
76                echo "  絶対パス: " . $file->getPathname() . "\n";
77                echo "  カスタムオブジェクトであるか: " . ($file->isCustomObject() ? 'Yes' : 'No') . "\n";
78            } else {
79                // ここには到達しないはずですが、念のため記述しています。
80                echo "  ファイル名: " . $file->getFilename() . " (標準オブジェクト)\n";
81            }
82            echo "---\n";
83        }
84    }
85} catch (UnexpectedValueException $e) {
86    echo "エラー: ディレクトリ '" . basename($testDir) . "' が存在しないか、読み取れません。\n";
87    echo $e->getMessage() . "\n";
88} finally {
89    // テスト用に作成したディレクトリとファイルをクリーンアップします。
90    echo "\nクリーンアップ中...\n";
91    // RecursiveIteratorIterator を使って、サブディレクトリも含めてすべて削除します。
92    $files = new RecursiveIteratorIterator(
93        new RecursiveDirectoryIterator($testDir, RecursiveDirectoryIterator::SKIP_DOTS),
94        RecursiveIteratorIterator::CHILD_FIRST
95    );
96    foreach ($files as $fileinfo) {
97        if ($fileinfo->isDir()) {
98            rmdir($fileinfo->getRealPath());
99        } else {
100            unlink($fileinfo->getRealPath());
101        }
102    }
103    rmdir($testDir);
104    echo "クリーンアップ完了。\n";
105}

RecursiveDirectoryIterator::setFileClass()メソッドは、ディレクトリを走査する際に、ファイルを表すオブジェクトのクラスを指定するために使用します。通常、ファイルオブジェクトは標準のSplFileObjectクラスのインスタンスとして生成されますが、このメソッドを使うことで、独自の振る舞いを持つカスタムクラスを指定できます。

引数$classには、ファイルオブジェクトとして使用したいクラス名を文字列で渡します。このクラスはSplFileObjectを継承していると、ファイルに関する基本的な情報を取得する既存のメソッド（例: getFilename()）を引き続き利用できます。戻り値はRecursiveDirectoryIteratorオブジェクト自身で、メソッドチェーンが可能です。

サンプルコードでは、まずSplFileObjectを継承したCustomFileObjectクラスを定義し、ファイル名に加えて独自のカスタム情報を返すgetCustomFileNameInfo()メソッドなどを追加しています。次に、RecursiveDirectoryIteratorのインスタンスに対してsetFileClass('CustomFileObject')を呼び出すことで、以降のファイル走査でCustomFileObjectのインスタンスが生成されるように設定しています。foreachループ内でget_class($file)やinstanceof CustomFileObjectを用いて、実際にカスタムクラスのオブジェクトが取得されていることを確認し、追加したカスタムメソッドを呼び出してその動作を示しています。これにより、ファイル処理の標準機能を拡張し、システムに合わせた独自の動作を組み込む方法を学べます。

Copy
1<?php
2
3/**
4 * RecursiveDirectoryIterator::setFileClass() で使用されるカスタムファイルオブジェクトクラス。
5 *
6 * SplFileObject を継承することで、ファイル操作の基本機能を受け継ぎつつ、
7 * 必要に応じて独自のプロパティやメソッドを追加できます。
8 */
9class MyCustomFileObject extends SplFileObject
10{
11    /**
12     * コンストラクタ。SplFileObjectの機能を継承しつつ、独自の初期化が可能です。
13     *
14     * @param string $filename ファイルパス
15     * @param string $openMode ファイルのオープンモード
16     * @param bool $useIncludePath include_pathを使用するかどうか
17     * @param resource|null $context コンテキストリソース
18     */
19    public function __construct(string $filename, string $openMode = 'r', bool $useIncludePath = false, ?resource $context = null)
20    {
21        parent::__construct($filename, $openMode, $useIncludePath, $context);
22        // ここにカスタムの初期化処理（例: ログ出力）を追加できます。
23        // echo "INFO: Custom file object created for: " . $this->getPathname() . "\n";
24    }
25
26    /**
27     * ファイルの拡張子を大文字で返すカスタムメソッド。
28     * このように、カスタムクラスに独自のファイル操作メソッドを追加できます。
29     *
30     * @return string ファイルの拡張子（大文字）
31     */
32    public function getExtensionInUpperCase(): string
33    {
34        // SplFileInfo::getExtension() は SplFileObject が継承しているため利用可能
35        return strtoupper($this->getExtension());
36    }
37}
38
39/**
40 * テスト用のディレクトリとファイルをセットアップします。
41 * 既に存在する場合は削除し、新しく作成します。
42 *
43 * @param string $baseDir テストディレクトリのパス
44 */
45function setupTestDirectory(string $baseDir): void
46{
47    // 既存のディレクトリとファイルをクリーンアップ
48    if (file_exists($baseDir)) {
49        cleanupTestDirectory($baseDir);
50    }
51
52    // ディレクトリを作成
53    mkdir($baseDir, 0777, true);
54    mkdir($baseDir . '/subdir', 0777, true);
55
56    // テストファイルを作成
57    file_put_contents($baseDir . '/file1.txt', 'Content for file1.txt');
58    file_put_contents($baseDir . '/subdir/file2.log', 'Content for file2.log');
59    file_put_contents($baseDir . '/MyClass.php', '<?php class MyClass {}'); // PHPクラス定義ファイルも追加
60}
61
62/**
63 * テスト用のディレクトリとファイルをクリーンアップします。
64 *
65 * @param string $baseDir テストディレクトリのパス
66 */
67function cleanupTestDirectory(string $baseDir): void
68{
69    if (!file_exists($baseDir)) {
70        return;
71    }
72
73    // ディレクトリの内容を再帰的に削除
74    $it = new RecursiveDirectoryIterator($baseDir, RecursiveDirectoryIterator::SKIP_DOTS);
75    $files = new RecursiveIteratorIterator($it, RecursiveIteratorIterator::CHILD_FIRST);
76
77    foreach ($files as $file) {
78        if ($file->isDir()) {
79            rmdir($file->getRealPath());
80        } else {
81            unlink($file->getRealPath());
82        }
83    }
84    rmdir($baseDir);
85}
86
87/**
88 * RecursiveDirectoryIterator と setFileClass を使用して、
89 * ディレクトリ内のファイルを走査し、カスタムファイルオブジェクトでパス情報を取得する例を示します。
90 *
91 * @param string $baseDir 走査するディレクトリのパス
92 */
93function demonstrateCustomFileIterator(string $baseDir): void
94{
95    // テスト環境のセットアップ
96    setupTestDirectory($baseDir);
97    echo "--- Scanning directory: {$baseDir} ---\n\n";
98
99    try {
100        // 1. RecursiveDirectoryIterator を作成し、ドットファイルをスキップするように設定
101        $directoryIterator = new RecursiveDirectoryIterator(
102            $baseDir,
103            RecursiveDirectoryIterator::SKIP_DOTS
104        );
105
106        // 2. setFileClass() を使用して、イテレータが返すファイルオブジェクトのクラスを
107        //    カスタムクラス (MyCustomFileObject) に設定します。
108        //    これにより、ディレクトリ走査時に SplFileObject の代わりに MyCustomFileObject のインスタンスが生成されます。
109        $directoryIterator->setFileClass(MyCustomFileObject::class);
110
111        // 3. RecursiveIteratorIterator を使用して、ディレクトリを再帰的に走査し、ファイルのみを取得
112        $iterator = new RecursiveIteratorIterator(
113            $directoryIterator,
114            RecursiveIteratorIterator::LEAVES_ONLY // ディレクトリではなくファイルのみを処理
115        );
116
117        echo "Found files using MyCustomFileObject:\n";
118        foreach ($iterator as $file) {
119            // $file は MyCustomFileObject のインスタンスであることが保証されます。
120            echo "----------------------------------------\n";
121            echo "File Name: " . $file->getFilename() . "\n";           // ファイル名を取得
122            echo "Full Path: " . $file->getPathname() . "\n";          // ファイルの絶対パスを取得 (キーワードに関連)
123            echo "Class Type: " . get_class($file) . "\n";             // ファイルオブジェクトのクラス名を確認 (カスタムクラスが適用されていることを確認)
124            echo "Uppercase Extension: " . $file->getExtensionInUpperCase() . "\n"; // カスタムメソッドの使用例
125        }
126        echo "----------------------------------------\n";
127
128    } catch (UnexpectedValueException $e) {
129        echo "Error during directory scan: " . $e->getMessage() . "\n";
130    } finally {
131        // 処理終了後、テスト環境をクリーンアップ
132        echo "\n--- Cleaning up test directory ---\n";
133        cleanupTestDirectory($baseDir);
134    }
135}
136
137// スクリプトの実行エントリポイント
138// 現在のスクリプトがあるディレクトリに一時的なテストディレクトリを作成します。
139$testDirectoryPath = __DIR__ . '/_temp_recursive_dir_test';
140demonstrateCustomFileIterator($testDirectoryPath);

RecursiveDirectoryIterator::setFileClass() メソッドは、PHPでディレクトリを再帰的に走査する際に、各ファイルを表すオブジェクトの型を変更するために使用されます。通常、このイテレータは各ファイルを SplFileObject のインスタンスとして返しますが、このメソッドを使うことで、開発者が定義したカスタムクラスのインスタンスを返させることができます。

引数 $class には、使用したいカスタムファイルオブジェクトのクラス名を文字列で指定します。このカスタムクラスは SplFileObject を継承している必要があります。そうすることで、ファイル操作に必要な基本的な機能を受け継ぎつつ、独自のプロパティやメソッドを追加できます。戻り値は設定後の RecursiveDirectoryIterator オブジェクト自身であり、メソッドチェーンによる連続した設定が可能です。

提供されたサンプルコードでは、MyCustomFileObject というカスタムクラスを定義し、setFileClass() メソッドでこれを指定しています。これにより、ディレクトリを走査した際に取得される $file オブジェクトは全て MyCustomFileObject のインスタンスとなります。したがって、getPathname() メソッドでファイルのパスを取得できるだけでなく、カスタム定義された getExtensionInUpperCase() のようなメソッドも利用できるようになります。これは、ファイルパスを含むファイル情報に独自の処理を加えたい場合に非常に役立ちます。