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

Copy
1<?php
2
3/**
4 * GlobIterator を使用して、指定されたパターンに一致するファイルの拡張子を表示します。
5 *
6 * この関数は、ファイルシステムを反復処理し、各ファイルの情報を取得する方法を示します。
7 * 特に、ファイルの拡張子を取得する `getExtension` メソッドの使用例を提供します。
8 *
9 * PHP 8 の GlobIterator は FilesystemIterator を継承し、
10 * 各要素を SplFileInfo オブジェクトとして返します。
11 * getExtension メソッドは、この SplFileInfo オブジェクトに存在します。
12 */
13function showFileExtensionsByGlob()
14{
15    // PHPスクリプトと同じディレクトリ内の全てのファイルとディレクトリを対象とします。
16    // 例: example.php, document.txt, image.jpg などが想定されます。
17    // スクリプト実行前に、テスト用のファイルをこのディレクトリに作成すると動作を確認できます。
18    // 例: touch('test_file.php'); touch('document.pdf'); touch('noextension');
19    $iterator = new GlobIterator(__DIR__ . '/*');
20
21    // イテレータが空の場合（指定されたパターンに一致するファイルが見つからない場合）のメッセージ。
22    if (!$iterator->valid()) {
23        echo "指定されたパターンに一致するファイルが見つかりませんでした。\n";
24        echo "テスト用のファイルをこのディレクトリに作成してみてください。\n";
25        return;
26    }
27
28    echo "--- ファイル拡張子リスト ---\n";
29
30    // GlobIterator はイテレーション中に SplFileInfo クラスのインスタンスを返します。
31    // SplFileInfo オブジェクトは、ファイル名、パス、拡張子などの詳細情報を提供します。
32    foreach ($iterator as $fileInfo) {
33        // ディレクトリは処理をスキップし、ファイルのみを対象とします。
34        if ($fileInfo->isDir()) {
35            continue;
36        }
37
38        // SplFileInfo::getExtension() メソッドを使用して、ファイルの拡張子を取得します。
39        // 例えば 'my_document.txt' からは 'txt' を返します。
40        // 'archive.tar.gz' の場合は 'gz' を返します。
41        $extension = $fileInfo->getExtension();
42
43        // ファイル名と拡張子を整形して表示します。
44        // 拡張子がない場合は "(なし)" と表示します。
45        echo sprintf(
46            "ファイル名: %-30s 拡張子: %s\n",
47            $fileInfo->getFilename(),
48            empty($extension) ? '(なし)' : $extension
49        );
50    }
51
52    echo "--------------------------\n";
53
54    // 注意: このスクリプトはテスト用のファイルを自動で作成・削除しません。
55    // テスト後は必要に応じて手動でファイルを削除してください。
56}
57
58// 関数を実行します。
59showFileExtensionsByGlob();

このPHPサンプルコードは、GlobIteratorというクラスとgetExtensionメソッドを使って、指定されたディレクトリ内のファイルから拡張子を取得し表示する方法を具体的に示しています。

まず、GlobIteratorは、__DIR__ . '/*' のようにワイルドカードを含むパターンを指定することで、現在のスクリプトと同じディレクトリにあるファイルやディレクトリを効率的に見つけ出します。このイテレータをforeachで反復処理すると、各要素はファイルに関する詳細情報を持つSplFileInfoというオブジェクトとして取得できます。

このSplFileInfoオブジェクトが提供するgetExtensionメソッドは、そのファイル名から拡張子を文字列として取得する役割を持っています。このメソッドは引数を必要とせず、例えば「document.txt」からは「txt」を、「archive.tar.gz」からは「gz」といった文字列を返します。もしファイルに拡張子がない場合は、空の文字列が戻り値となります。

コードでは、GlobIteratorで見つかった項目の中からディレクトリを除外し、ファイルだけを対象とします。そして、それぞれのSplFileInfoオブジェクトからgetExtensionメソッドを呼び出し、取得した拡張子をファイル名とともに整形して表示しています。これにより、ファイルシステムを操作し、特定のファイル情報（この場合は拡張子）を取り出す基本的な手法を学ぶことができます。