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

Copy
1<?php
2
3/**
4 * 一時ディレクトリを作成し、テストファイルを用意します。
5 *
6 * @param string $dirPath 作成する一時ディレクトリのパス。
7 * @throws RuntimeException ディレクトリ作成に失敗した場合。
8 */
9function setupTestEnvironment(string $dirPath): void
10{
11    // ディレクトリが存在しない場合、作成を試みる
12    if (!is_dir($dirPath) && !mkdir($dirPath, 0777, true)) {
13        throw new RuntimeException("一時ディレクトリ '$dirPath' の作成に失敗しました。");
14    }
15
16    // 様々な拡張子を持つテストファイルを作成します。
17    // getExtension() の動作を確認するためのファイルを配置
18    file_put_contents($dirPath . '/document.txt', 'This is a text file.');
19    file_put_contents($dirPath . '/image.jpg', 'This is an image file content.');
20    file_put_contents($dirPath . '/archive.tar.gz', 'This is an archive file content.'); // 複数の拡張子を持つファイル
21    file_put_contents($dirPath . '/noextension', 'This file has no extension.'); // 拡張子がないファイル
22    file_put_contents($dirPath . '/.env', 'APP_ENV=development'); // ドットから始まるファイル（隠しファイル）
23    
24    // サブディレクトリも作成します。FilesystemIterator はデフォルトでサブディレクトリの中身は走査しませんが、
25    // ディレクトリ自体はイテレーションの対象となります。
26    mkdir($dirPath . '/subdirectory', 0777, true); 
27    file_put_contents($dirPath . '/subdirectory/nested.php', '<?php echo "Hello from nested file";');
28}
29
30/**
31 * 作成したテスト環境（一時ディレクトリとファイル）をクリーンアップします。
32 *
33 * @param string $dirPath 削除する一時ディレクトリのパス。
34 */
35function cleanupTestEnvironment(string $dirPath): void
36{
37    // ディレクトリが存在しない場合は何もしない
38    if (!is_dir($dirPath)) {
39        return;
40    }
41
42    // ディレクトリ内のファイルやサブディレクトリを再帰的に削除するためのイテレータを使用します。
43    // RecursiveIteratorIterator::CHILD_FIRST は、子要素（ファイルやサブディレクトリ）を先に削除し、
44    // その後に親ディレクトリを削除するために必要です。
45    $files = new RecursiveIteratorIterator(
46        new RecursiveDirectoryIterator($dirPath, RecursiveDirectoryIterator::SKIP_DOTS), // . と .. をスキップ
47        RecursiveIteratorIterator::CHILD_FIRST
48    );
49
50    foreach ($files as $fileinfo) {
51        if ($fileinfo->isDir()) {
52            // アイテムがディレクトリの場合、削除
53            rmdir($fileinfo->getRealPath());
54        } else {
55            // アイテムがファイルの場合、削除
56            unlink($fileinfo->getRealPath());
57        }
58    }
59    // すべての子要素が削除された後、ルートディレクトリを削除
60    rmdir($dirPath);
61}
62
63/**
64 * FilesystemIterator と getExtension() メソッドの動作を示すメイン関数。
65 * システムエンジニアを目指す初心者向けに、ファイルの拡張子を取得する方法を実演します。
66 */
67function demonstrateGetExtension(): void
68{
69    // 一時ディレクトリのパスを定義します。
70    // __DIR__ は現在のスクリプトが置かれているディレクトリを指します。
71    $tempDir = __DIR__ . '/temp_files_for_extension_test';
72
73    try {
74        // 1. テスト環境の準備: 一時ディレクトリとテストファイルを作成します。
75        setupTestEnvironment($tempDir);
76        echo "一時ディレクトリ '$tempDir' にテストファイルを作成しました。\n\n";
77
78        // 2. FilesystemIterator を使用して指定したディレクトリを走査し、各アイテムの拡張子を取得します。
79        // FilesystemIterator はディレクトリ内の各ファイルやディレクトリを SplFileInfo オブジェクトとして返します。
80        // getExtension() メソッドは、この SplFileInfo オブジェクトのメソッドです。
81        $iterator = new FilesystemIterator($tempDir);
82
83        echo "ディレクトリ内のアイテムと拡張子:\n";
84        echo "---------------------------------\n";
85
86        // $iterator を foreach ループで回すと、各要素が SplFileInfo オブジェクトとして $fileInfo に入ります。
87        foreach ($iterator as $fileInfo) {
88            $filename = $fileInfo->getFilename();
89
90            // . (カレントディレクトリ) と .. (親ディレクトリ) はスキップします。
91            // これらは実際のファイルやディレクトリではないため、処理を続行しません。
92            if ($fileInfo->isDot()) {
93                continue;
94            }
95
96            if ($fileInfo->isFile()) {
97                // アイテムがファイルの場合、getExtension() メソッドで拡張子を取得します。
98                $extension = $fileInfo->getExtension();
99
100                echo "ファイル名: '$filename' -> 拡張子: ";
101                if ($extension === '') {
102                    echo "(なし)\n"; // 拡張子がない場合
103                } else {
104                    echo "'$extension'\n";
105                }
106            } elseif ($fileInfo->isDir()) {
107                // アイテムがディレクトリの場合、getExtension() メソッドは空文字列を返します。
108                // ディレクトリには拡張子という概念がないためです。
109                echo "ディレクトリ: '" . $fileInfo->getFilename() . "' (拡張子はありません)\n";
110            }
111        }
112        echo "---------------------------------\n";
113
114    } catch (Exception $e) {
115        // 処理中にエラーが発生した場合、そのメッセージを出力します。
116        echo "エラーが発生しました: " . $e->getMessage() . "\n";
117    } finally {
118        // 3. テスト環境のクリーンアップ: 作成した一時ディレクトリとその内容を削除します。
119        // この処理は、エラーの有無に関わらず必ず実行されます。
120        cleanupTestEnvironment($tempDir);
121        echo "\n一時ディレクトリ '$tempDir' とその内容を削除しました。\n";
122    }
123}
124
125// スクリプトの実行
126demonstrateGetExtension();

PHPのFilesystemIterator::getExtension()メソッドは、ファイルシステムを走査する際に、現在処理しているファイルまたはディレクトリの拡張子を文字列として取得するために使用されます。このメソッドはFilesystemIteratorが返すSplFileInfoオブジェクトに属しており、ファイルやディレクトリに関する詳細な情報を扱う際に非常に便利です。

このメソッドは引数を一切取りません。戻り値は常にstring型で、ファイル名から最後のドット（.）以降の文字列を返します。例えば、「document.txt」からは「txt」が、「image.jpg」からは「jpg」が取得できます。複数のドットを含むファイル名（例: 「archive.tar.gz」）の場合、最後のドット以降、つまり「gz」が拡張子として返されます。拡張子がないファイル（例: 「noextension」）の場合や、ドットから始まるファイル（例: 「.env」）で最後のドット以降に文字列がないと判断される場合、空の文字列が返されます。ただし、「.env」のようなファイルでは「env」が返されます。ディレクトリに対してこのメソッドを呼び出した場合も、拡張子という概念がないため、空の文字列が返されます。

システムエンジニアとしてファイルの種類を判別したり、特定の拡張子のファイルを処理したりする際に、このメソッドはファイルの属性情報を簡単に取得する手段として役立ちます。