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

Copy
1<?php
2
3/**
4 * FilesystemIterator::getBasename() の使用例を示す関数。
5 *
6 * この関数は一時ファイルを作成し、FilesystemIterator を使用してそのファイル名（基底名）を
7 * 取得する方法、およびオプションでサフィックスを除外する方法を示します。
8 */
9function demonstrateFilesystemIteratorGetBasename(): void
10{
11    // 1. 一時ディレクトリとユニークなファイル名を生成
12    $tempDir = sys_get_temp_dir();
13    $fileName = 'example_file_' . uniqid() . '.txt';
14    $filePath = $tempDir . DIRECTORY_SEPARATOR . $fileName;
15
16    // 2. 一時ファイルを作成
17    if (file_put_contents($filePath, 'Hello, PHP!') === false) {
18        echo "エラー: 一時ファイルの作成に失敗しました。\n";
19        return;
20    }
21    echo "一時ファイルを作成しました: " . $filePath . "\n\n";
22
23    try {
24        // 3. FilesystemIterator をインスタンス化
25        // FilesystemIterator はディレクトリを反復処理するため、ファイルの親ディレクトリを指定します。
26        $iterator = new FilesystemIterator(dirname($filePath));
27
28        echo "FilesystemIterator を使用してファイル名（基底名）を取得します。\n";
29
30        // 4. イテレータをループして目的のファイルを探し、getBasename() を呼び出す
31        foreach ($iterator as $fileInfo) {
32            // 現在のファイルが作成した一時ファイルと一致するか確認
33            if ($fileInfo->getPathname() === $filePath) {
34                echo "対象ファイルが見つかりました: " . $fileInfo->getFilename() . "\n";
35
36                // 引数なしで getBasename() を呼び出す: ファイル名全体（拡張子を含む）
37                $basenameFull = $fileInfo->getBasename();
38                echo "  getBasename() (引数なし): " . $basenameFull . "\n";
39
40                // サフィックス (.txt) を指定して getBasename() を呼び出す: 拡張子を除外
41                $basenameWithoutTxt = $fileInfo->getBasename('.txt');
42                echo "  getBasename('.txt'): " . $basenameWithoutTxt . "\n";
43
44                // 存在しないサフィックス (.csv) を指定した場合: 変更なし
45                $basenameWithNonExistentSuffix = $fileInfo->getBasename('.csv');
46                echo "  getBasename('.csv') (存在しないサフィックス): " . $basenameWithNonExistentSuffix . "\n";
47
48                break; // 目的のファイルを見つけたのでループを終了
49            }
50        }
51    } catch (UnexpectedValueException $e) {
52        echo "エラー: ディレクトリにアクセスできませんでした: " . $e->getMessage() . "\n";
53    } finally {
54        // 5. 作成した一時ファイルをクリーンアップ
55        if (file_exists($filePath)) {
56            unlink($filePath);
57            echo "\n一時ファイルを削除しました: " . $filePath . "\n";
58        }
59    }
60}
61
62// 関数を実行
63demonstrateFilesystemIteratorGetBasename();

FilesystemIterator::getBasename()は、PHP 8で導入されたFilesystemIteratorクラスに属するメソッドです。このメソッドは、ファイルパスからディレクトリ部分を除いた「基底名」（ファイル名）を取得するために使用されます。FilesystemIteratorは、ディレクトリ内のファイルやサブディレクトリの情報を反復処理する際に非常に役立つクラスです。

メソッドは?string $suffix = nullというオプションの引数を受け取ります。この$suffix引数に文字列（例えばファイルの拡張子「.txt」など）を指定すると、戻り値の基底名からそのサフィックスが除外されます。引数を省略するかnullを指定した場合、ファイル名全体（拡張子を含む）がそのまま基底名として返されます。戻り値は常に文字列型です。

提供されたサンプルコードでは、一時ファイルを作成し、そのファイルに対してgetBasename()の挙動を確認しています。引数なしでgetBasename()を呼び出すとファイル名全体が取得され、ファイル名の一部である.txtを$suffixとして指定すると、その部分が除外された基底名が取得される様子が示されています。これにより、ファイルパスから必要なファイル名部分のみを効率的に抽出できることがわかります。

Copy
1<?php
2
3// このサンプルコードは、FilesystemIterator::getBasename() メソッドの使い方を示します。
4// getBasename() は、ファイルやディレクトリのフルパスからファイル名（またはディレクトリ名）の部分を取得します。
5// オプションで、指定した拡張子（サフィックス）を除去することもできます。
6
7// 1. 一時ディレクトリとファイル名の設定
8$tempDir = __DIR__ . DIRECTORY_SEPARATOR . 'example_files_dir';
9$tempFile1 = $tempDir . DIRECTORY_SEPARATOR . 'document.txt';
10$tempFile2 = $tempDir . DIRECTORY_SEPARATOR . 'image.jpg';
11$tempFile3 = $tempDir . DIRECTORY_SEPARATOR . 'archive.tar.gz';
12
13// 2. テスト用のディレクトリを作成
14if (!is_dir($tempDir)) {
15    mkdir($tempDir, 0777, true); // 存在しない場合はディレクトリを作成
16    echo "一時ディレクトリ '{$tempDir}' を作成しました。\n";
17}
18
19// 3. テスト用のファイルを作成
20file_put_contents($tempFile1, 'これはテキストファイルです。');
21file_put_contents($tempFile2, 'これは画像ファイルです。');
22file_put_contents($tempFile3, 'これは圧縮ファイルです。');
23echo "一時ファイルを作成しました。\n\n";
24
25echo "--- FilesystemIterator::getBasename() の使用例 ---\n";
26echo "対象ディレクトリ: {$tempDir}\n\n";
27
28try {
29    // FilesystemIterator のインスタンスを作成
30    // このイテレータは、指定されたディレクトリ内の各ファイルとディレクトリを反復処理します。
31    $iterator = new FilesystemIterator($tempDir);
32
33    // ディレクトリ内の各要素（ファイル、サブディレクトリ）をループ処理
34    foreach ($iterator as $fileInfo) {
35        echo "元のパス: " . $fileInfo->getPathname() . "\n";
36
37        // 拡張子を含んだファイル名を取得
38        // 例: document.txt
39        $basename = $fileInfo->getBasename();
40        echo "  getBasename() 結果: '{$basename}'\n";
41
42        // 特定のサフィックス（拡張子）を指定して、その部分を除去したファイル名を取得
43        // 例: document ('.txt' が除去される)
44        $basenameWithoutTxt = $fileInfo->getBasename('.txt');
45        echo "  getBasename('.txt') 結果: '{$basenameWithoutTxt}'\n";
46
47        // 別のサフィックスを除去する例 (例: .jpg)
48        $basenameWithoutJpg = $fileInfo->getBasename('.jpg');
49        echo "  getBasename('.jpg') 結果: '{$basenameWithoutJpg}'\n";
50
51        // 複数の拡張子を持つファイルの場合の例 (例: .tar.gz)
52        // '.gz' を指定すると 'archive.tar' が得られます
53        $basenameWithoutGz = $fileInfo->getBasename('.gz');
54        echo "  getBasename('.gz') 結果: '{$basenameWithoutGz}'\n";
55
56        // '.tar.gz' を指定すると 'archive' が得られます
57        $basenameWithoutTarGz = $fileInfo->getBasename('.tar.gz');
58        echo "  getBasename('.tar.gz') 結果: '{$basenameWithoutTarGz}'\n";
59
60        // 存在しないサフィックスを指定した場合、ファイル名は変更されない
61        $basenameWithNonExistentSuffix = $fileInfo->getBasename('.xyz');
62        echo "  getBasename('.xyz') 結果: '{$basenameWithNonExistentSuffix}' (存在しないサフィックスは無視されます)\n";
63
64        echo "\n";
65    }
66} catch (UnexpectedValueException $e) {
67    // ディレクトリが存在しない、またはアクセス権がない場合に発生する可能性のあるエラーを捕捉
68    echo "エラーが発生しました: " . $e->getMessage() . "\n";
69} finally {
70    // クリーンアップ: 作成した一時ファイルとディレクトリを削除します。
71    echo "--- クリーンアップ --- \n";
72    if (file_exists($tempFile1)) {
73        unlink($tempFile1);
74        echo "一時ファイル '" . basename($tempFile1) . "' を削除しました。\n";
75    }
76    if (file_exists($tempFile2)) {
77        unlink($tempFile2);
78        echo "一時ファイル '" . basename($tempFile2) . "' を削除しました。\n";
79    }
80    if (file_exists($tempFile3)) {
81        unlink($tempFile3);
82        echo "一時ファイル '" . basename($tempFile3) . "' を削除しました。\n";
83    }
84
85    // ディレクトリが空であることを確認してから削除
86    if (is_dir($tempDir) && count(scandir($tempDir)) == 2) { // '.' と '..' のみの場合
87        rmdir($tempDir);
88        echo "一時ディレクトリ '" . basename($tempDir) . "' を削除しました。\n";
89    } elseif (is_dir($tempDir)) {
90        echo "警告: 一時ディレクトリ '" . basename($tempDir) . "' は空ではないため、削除できませんでした。手動で削除してください。\n";
91    }
92}

PHPのFilesystemIterator::getBasename()メソッドは、ファイルやディレクトリのフルパスからファイル名（またはディレクトリ名）の部分のみを抽出します。これはFilesystemIteratorが返すSplFileInfoオブジェクトから呼び出されます。

引数$suffixはオプションの?string型です。これを省略するかnullを指定した場合、拡張子を含むファイル名全体が文字列で返されます（例: 「document.txt」）。

$suffixに特定の文字列（通常は拡張子）を指定すると、ファイル名の末尾にその文字列が一致した場合にのみ除去されます（例: getBasename('.txt')が「document.txt」から「document」を返します）。一致しない場合はファイル名はそのままです。複数の拡張子を持つファイル（例: 「archive.tar.gz」）に対しても、指定したサフィックスを除去した結果を得られます。

戻り値は常にstring型で、抽出されたファイル名が返されます。

サンプルコードは、一時ディレクトリ内に用意した様々なファイルをFilesystemIteratorで順に処理し、getBasename()の利用例を示します。引数なしの場合、単一拡張子、複数拡張子、そして存在しない拡張子を指定した場合の呼び出し例とその結果を確認できます。また、処理の最後には、作成された一時ファイルとディレクトリのクリーンアップも行われます。