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

Copy
1<?php
2
3/**
4 * RecursiveDirectoryIterator::getType() メソッドの使用例
5 *
6 * このコードは、一時ディレクトリとファイルを作成し、
7 * RecursiveDirectoryIterator を使用してファイルシステムを再帰的に走査します。
8 * 各エントリに対して getType() メソッドを呼び出し、その種類（ディレクトリ、ファイルなど）
9 * を取得して表示します。
10 * システムエンジニアを目指す初心者の方でも、ファイルシステム走査の基本と
11 * オブジェクトの型の判別方法を理解できるように設計されています。
12 */
13
14// 一時ディレクトリのパスを生成 (ユニークな名前で衝突を避ける)
15$tempDirPath = __DIR__ . DIRECTORY_SEPARATOR . 'temp_recursive_iterator_' . uniqid();
16
17try {
18    // 走査対象となる一時ディレクトリとその内容を準備する
19    // mkdir() の第三引数 true で、ネストされたディレクトリも作成可能
20    if (!mkdir($tempDirPath, 0777, true)) {
21        throw new RuntimeException("一時ディレクトリ '{$tempDirPath}' の作成に失敗しました。");
22    }
23    // サンプルファイルを作成
24    file_put_contents($tempDirPath . DIRECTORY_SEPARATOR . 'document.txt', 'これはサンプルテキストファイルです。');
25    // サブディレクトリを作成
26    mkdir($tempDirPath . DIRECTORY_SEPARATOR . 'images');
27    // サブディレクトリ内に別のサンプルファイルを作成
28    file_put_contents($tempDirPath . DIRECTORY_SEPARATOR . 'images' . DIRECTORY_SEPARATOR . 'photo.jpg', 'ダミーコンテンツ');
29    // 空のサブディレクトリも作成
30    mkdir($tempDirPath . DIRECTORY_SEPARATOR . 'empty_folder');
31
32    echo "--- RecursiveDirectoryIterator::getType() サンプル実行 ---" . PHP_EOL;
33    echo "走査対象のディレクトリ: " . $tempDirPath . PHP_EOL . PHP_EOL;
34
35    // RecursiveDirectoryIterator のインスタンスを作成
36    // FilesystemIterator::SKIP_DOTS フラグは、'.' と '..' エントリをスキップし、よりクリーンな出力にします。
37    $directoryIterator = new RecursiveDirectoryIterator($tempDirPath, FilesystemIterator::SKIP_DOTS);
38
39    // RecursiveIteratorIterator でラップすることで、サブディレクトリの中も再帰的に走査できるようになります。
40    // RecursiveIteratorIterator::SELF_FIRST は、ディレクトリ自体をその内容より先に処理することを意味します。
41    $recursiveIterator = new RecursiveIteratorIterator($directoryIterator, RecursiveIteratorIterator::SELF_FIRST);
42
43    // イテレータをループし、各ファイルシステムエントリの情報を取得
44    foreach ($recursiveIterator as $fileInfo) {
45        // SplFileInfo (RecursiveDirectoryIterator が継承) の getType() メソッドを呼び出し
46        // 現在のエントリが 'dir' (ディレクトリ)、'file' (ファイル)、'link' (シンボリックリンク)
47        // など、どの種類であるかを示す文字列を取得します。
48        echo sprintf(
49            "パス: %s, 種類: %s\n",
50            $fileInfo->getPathname(), // エントリのフルパス
51            $fileInfo->getType()       // エントリの種類
52        );
53    }
54
55    echo PHP_EOL . "--- 処理完了 ---" . PHP_EOL;
56
57} catch (Exception $e) {
58    // エラーが発生した場合、メッセージを表示
59    echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
60} finally {
61    // スクリプト終了時に、作成した一時ディレクトリとその内容をクリーンアップ
62    // これはサンプルコードの副作用をなくし、環境をきれいに保つための重要な処理です。
63    if (is_dir($tempDirPath)) {
64        // ディレクトリを再帰的に削除するヘルパー関数
65        $deleteRecursiveDir = function ($dir) use (&$deleteRecursiveDir) {
66            // ディレクトリが存在しない場合は何もしない
67            if (!is_dir($dir)) {
68                return;
69            }
70            // ドットエントリ ('.' と '..') をスキップしてイテレータを作成
71            $items = new FilesystemIterator($dir, FilesystemIterator::SKIP_DOTS);
72            foreach ($items as $item) {
73                // ディレクトリであれば再帰的に削除関数を呼び出す
74                if ($item->isDir()) {
75                    $deleteRecursiveDir($item->getPathname());
76                } else {
77                    // ファイルであれば削除
78                    unlink($item->getPathname());
79                }
80            }
81            // 最後に空になったディレクトリを削除
82            rmdir($dir);
83        };
84        $deleteRecursiveDir($tempDirPath);
85        // echo "一時ディレクトリ '{$tempDirPath}' を削除しました。" . PHP_EOL; // デバッグ用にコメント解除可
86    }
87}

このサンプルコードは、PHPのRecursiveDirectoryIteratorクラスとRecursiveIteratorIteratorクラスを用いて、指定されたディレクトリの内容を再帰的に走査し、各要素の種類を判別する方法を示しています。

まず、一時ディレクトリとファイルを作成し、走査対象となるファイルシステム構造を準備します。次に、RecursiveDirectoryIteratorのインスタンスを作成することで、ディレクトリ内のエントリを一つずつ扱えるようになります。このオブジェクトをRecursiveIteratorIteratorでラップすると、サブディレクトリの中まで自動的に深く探索できるようになります。

ループ内で各ファイルシステムエントリに対して呼び出されるのが、SplFileInfoクラス（RecursiveDirectoryIteratorが継承しています）のgetType()メソッドです。このメソッドは引数を取りません。現在のエントリが「ディレクトリ」なのか、「ファイル」なのか、あるいは「シンボリックリンク」なのかといった種類を文字列として返します。例えば、ディレクトリであれば「dir」、通常のファイルであれば「file」といった値が戻り値として得られます。

このように、getType()メソッドを使用することで、ファイルシステム上の様々な要素をプログラムで識別し、それに応じた処理を分岐させることが可能になります。システムエンジニアを目指す上で、ファイルシステムを扱う際の基本的な情報取得方法として非常に役立ちます。

Copy
1<?php
2
3// このスクリプトは、RecursiveDirectoryIterator::getType() メソッドの使用例を示します。
4// このメソッドは、ファイルシステム上の各エントリ（ファイルまたはディレクトリ）の種類を取得します。
5// これは、ファイルシステムのエントリという「変数」のようなものの「型」（種類）を知る一例です。
6
7/**
8 * 指定されたディレクトリとその内容を再帰的に削除します。
9 *
10 * @param string $dir 削除するディレクトリのパス
11 * @return void
12 */
13function deleteDirectoryRecursively(string $dir): void
14{
15    if (!is_dir($dir)) {
16        return;
17    }
18
19    // ディレクトリ内のすべてのファイルとサブディレクトリをスキャンします
20    $files = array_diff(scandir($dir), ['.', '..']);
21
22    foreach ($files as $file) {
23        $path = $dir . DIRECTORY_SEPARATOR . $file;
24        if (is_dir($path)) {
25            // サブディレクトリであれば再帰的に削除
26            deleteDirectoryRecursively($path);
27        } else {
28            // ファイルであれば削除
29            unlink($path);
30        }
31    }
32    // ディレクトリが空になったら削除
33    rmdir($dir);
34}
35
36// 1. テスト用のディレクトリとファイルを作成します
37$testBaseDir = __DIR__ . DIRECTORY_SEPARATOR . 'sample_dir_for_gettype';
38$subDir = $testBaseDir . DIRECTORY_SEPARATOR . 'subdir';
39$file1 = $testBaseDir . DIRECTORY_SEPARATOR . 'document.txt';
40$file2 = $subDir . DIRECTORY_SEPARATOR . 'image.jpg';
41
42// ディレクトリが存在しない場合は作成
43if (!is_dir($testBaseDir)) {
44    mkdir($testBaseDir, 0777, true);
45}
46if (!is_dir($subDir)) {
47    mkdir($subDir, 0777, true);
48}
49
50// テスト用ファイルを作成
51file_put_contents($file1, 'This is a sample text file.');
52file_put_contents($file2, 'This is a sample image file content.');
53
54echo "--- RecursiveDirectoryIterator::getType() の使用例 ---\n\n";
55
56try {
57    // 2. RecursiveDirectoryIterator を使用して、指定されたディレクトリを再帰的に走査します
58    // RecursiveDirectoryIterator はディレクトリ内のエントリごとに SplFileInfo オブジェクトを返します
59    $iterator = new RecursiveDirectoryIterator($testBaseDir);
60
61    // RecursiveIteratorIterator は RecursiveDirectoryIterator と組み合わせて、
62    // サブディレクトリ内のエントリも含めて再帰的にイテレーションできるようにします
63    $recursiveIterator = new RecursiveIteratorIterator($iterator);
64
65    echo "対象ディレクトリ: " . realpath($testBaseDir) . "\n\n";
66    echo "各エントリのパスと種類 (getType()) を表示:\n";
67    echo "--------------------------------------------------\n";
68
69    // 3. 各エントリをループ処理し、getType() メソッドでその種類を取得します
70    foreach ($recursiveIterator as $fileInfo) {
71        // getType() メソッドは、現在のエントリがディレクトリ ('dir') かファイル ('file') かを文字列で返します。
72        // この情報は、ファイルシステムオブジェクトの「型」を理解するのに役立ちます。
73        $type = $fileInfo->getType();
74        $path = $fileInfo->getPathname(); // エントリのフルパスを取得
75
76        echo "パス: {$path}\n";
77        echo "種類: {$type}\n"; // 'dir' または 'file' が表示されます
78        echo "--------------------------------------------------\n";
79    }
80
81} catch (UnexpectedValueException $e) {
82    echo "エラー: 指定されたパスが存在しないか、ディレクトリではありません。\n";
83    echo "詳細: " . $e->getMessage() . "\n";
84} catch (Exception $e) {
85    echo "予期せぬエラーが発生しました。\n";
86    echo "詳細: " . $e->getMessage() . "\n";
87} finally {
88    // 4. テスト用に作成したディレクトリとファイルをクリーンアップします
89    echo "\n--- クリーンアップ中 ---\n";
90    deleteDirectoryRecursively($testBaseDir);
91    echo "テストディレクトリとファイルが削除されました。\n";
92}
93
94?>

PHPのRecursiveDirectoryIterator::getType()メソッドは、ファイルシステム上を走査する際に、現在処理しているエントリがファイルなのか、それともディレクトリなのかを判別するために使用されます。このメソッドは引数を必要とせず、現在のエントリの種類を示す文字列を戻り値として返します。具体的には、エントリがディレクトリであれば'dir'、ファイルであれば'file'という文字列が返されます。

サンプルコードでは、まずテスト用のファイルとディレクトリを作成し、それらをRecursiveDirectoryIteratorとRecursiveIteratorIteratorを組み合わせて再帰的に走査しています。ループ処理の中で、各エントリを表すオブジェクトに対してgetType()メソッドを呼び出し、そのエントリの種類を正確に取得し、パスとともに表示しています。これにより、プログラムがファイルシステムの各要素を種類に応じて適切に処理する際の基本的な判断材料を得ることができます。このメソッドは、ファイルやディレクトリの構造をプログラムで扱う上で非常に役立ちます。