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

Copy
1<?php
2
3/**
4 * 指定されたディレクトリ内のファイルの拡張子を取得し、表示する関数。
5 *
6 * この関数は DirectoryIterator クラスを使用して指定ディレクトリを走査し、
7 * 各ファイルのエントリから getExtension() メソッドを使って拡張子を取得します。
8 *
9 * @param string $directoryPath 処理対象のディレクトリのパス。
10 *                               例: `.` (カレントディレクトリ) や `/path/to/my/files`
11 */
12function displayFileExtensions(string $directoryPath): void
13{
14    echo "指定ディレクトリ '{$directoryPath}' 内のファイルの拡張子を取得します:\n";
15    echo "--------------------------------------------------\n";
16
17    try {
18        // 指定したディレクトリのイテレータを作成
19        // DirectoryIterator は、ディレクトリ内のファイルやサブディレクトリを反復処理するためのクラスです。
20        $iterator = new DirectoryIterator($directoryPath);
21
22        // ディレクトリ内のエントリを一つずつ処理
23        foreach ($iterator as $fileInfo) {
24            // . や .. (カレントディレクトリと親ディレクトリ) を除外し、かつファイルである場合のみ処理
25            // isFile() は、現在のエントリが通常のファイルである場合に true を返します。
26            if ($fileInfo->isFile()) {
27                // ファイル名を取得
28                $filename = $fileInfo->getFilename();
29
30                // ファイルの拡張子を取得
31                // getExtension() は、パスの最後のドット以降の部分を拡張子として返します。
32                // 拡張子がない場合は空文字列が返されます。
33                $extension = $fileInfo->getExtension();
34
35                // 結果を表示
36                if ($extension === '') {
37                    echo "- ファイル: " . $filename . " (拡張子なし)\n";
38                } else {
39                    echo "- ファイル: " . $filename . ", 拡張子: ." . $extension . "\n";
40                }
41            }
42        }
43    } catch (UnexpectedValueException $e) {
44        // ディレクトリが見つからない、またはアクセス権がない場合のエラーハンドリング
45        echo "エラー: 指定されたディレクトリが見つからないか、アクセスできません。\n";
46        echo "詳細: " . $e->getMessage() . "\n";
47    }
48
49    echo "--------------------------------------------------\n";
50}
51
52// スクリプトがある現在のディレクトリを対象とします。
53// このスクリプトと同じディレクトリに、事前にいくつかのファイル（例: mydocument.txt, photo.jpg, script.php, README）
54// を作成しておくと、さまざまな拡張子の取得結果を確認できます。
55$targetDirectory = __DIR__;
56
57// 関数を呼び出して実行
58displayFileExtensions($targetDirectory);
59
60?>

PHPのDirectoryIterator::getExtensionメソッドは、指定したディレクトリ内のファイルから拡張子を正確に取得するための機能です。このメソッドはDirectoryIteratorクラスに属しており、ディレクトリ内のファイルやサブディレクトリを効率的に反復処理する際に、各ファイルの情報（SplFileInfoオブジェクト）から拡張子を取り出すのに使用されます。

サンプルコードでは、まずDirectoryIteratorを使って指定ディレクトリを走査し、foreachループでファイル情報を一つずつ取り出します。その後、isFile()メソッドで現在のエントリが通常のファイルであるかを確認し、$fileInfo->getExtension()を呼び出すことで、そのファイルの拡張子を文字列として取得しています。このメソッドは引数を必要としません。戻り値はstring型で、ファイルの拡張子を返します。もしファイルに拡張子がない場合は、空の文字列が返されるため、サンプルコードのように拡張子があるかどうかの判定も可能です。この機能は、ファイルの種類を判別して処理を分けたい場合などに大変便利です。