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

Copy
1<?php
2
3/**
4 * GlobIterator::getBasename() の使用例を示します。
5 * この関数は、ファイルパスからファイル名（拡張子を含むか、指定された拡張子を除いたもの）を取得する方法を実演します。
6 * PHPのグローバル関数 basename() と同様の機能ですが、SplFileInfo オブジェクトのメソッドとして提供されます。
7 * システムエンジニアを目指す初心者の方にも理解しやすいよう、具体的なファイル操作を含んでいます。
8 */
9function demonstrateGlobIteratorGetBasename(): void
10{
11    // 1. デモンストレーション用のテストディレクトリとファイルを作成します。
12    $tempDir = __DIR__ . '/temp_glob_example';
13    if (!is_dir($tempDir)) {
14        mkdir($tempDir);
15    }
16    file_put_contents($tempDir . '/document.txt', 'これはテキストファイルです。');
17    file_put_contents($tempDir . '/report.log', 'これはログファイルです。');
18    file_put_contents($tempDir . '/image.jpg', 'これは画像ファイルです。');
19    mkdir($tempDir . '/my_folder'); // GlobIterator がディレクトリも取得することを示す
20
21    echo "--- GlobIterator::getBasename() のデモンストレーション ---" . PHP_EOL;
22    echo "テスト対象ディレクトリ: " . realpath($tempDir) . PHP_EOL;
23    echo "--------------------------------------------------------" . PHP_EOL;
24
25    try {
26        // GlobIterator を使用して、指定されたパターンに一致するファイルやディレクトリを走査します。
27        // ここでは `$tempDir` 内の全ての要素 (ファイルとディレクトリ) を対象とします。
28        $iterator = new GlobIterator($tempDir . '/*');
29
30        // 各要素について、ファイル名を抽出して表示します。
31        foreach ($iterator as $fileInfo) {
32            // GlobIterator は SplFileInfo オブジェクトを返します。
33            // SplFileInfo::getBasename() メソッドは、ファイルまたはディレクトリのフルパスから、
34            // 最後のコンポーネント（ファイル名またはディレクトリ名）を取得します。
35            // これは、PHPのグローバル関数 `basename()` と非常に似た機能を提供します。
36            $basename = $fileInfo->getBasename();
37            echo "元のパス: '" . $fileInfo->getPathname() . "' -> ベース名: '" . $basename . "'" . PHP_EOL;
38
39            // オプションの `$suffix` 引数を指定すると、そのサフィックスがベース名から削除されます。
40            // 例: '.txt' を指定すると 'document.txt' は 'document' になります。
41            $basenameWithoutTxt = $fileInfo->getBasename('.txt');
42            if ($basename !== $basenameWithoutTxt) { // 拡張子があった場合のみ表示
43                echo "  - '.txt' 拡張子を除去: '" . $basenameWithoutTxt . "'" . PHP_EOL;
44            }
45
46            $basenameWithoutLog = $fileInfo->getBasename('.log');
47            if ($basename !== $basenameWithoutLog) { // 拡張子があった場合のみ表示
48                echo "  - '.log' 拡張子を除去: '" . $basenameWithoutLog . "'" . PHP_EOL;
49            }
50        }
51    } catch (UnexpectedValueException $e) {
52        // GlobIterator のコンストラクタは、指定されたパターンに一致するファイルがない場合などに
53        // UnexpectedValueException をスローすることがあります。
54        echo "エラー: 指定されたパターンに一致するファイルが見つからないか、他の問題が発生しました。 " . $e->getMessage() . PHP_EOL;
55    } catch (Exception $e) {
56        echo "予期せぬエラーが発生しました: " . $e->getMessage() . PHP_EOL;
57    } finally {
58        // 2. クリーンアップ: 作成した一時ファイルとディレクトリを削除します。
59        echo PHP_EOL . "--- クリーンアップ中 ---" . PHP_EOL;
60        if (is_dir($tempDir)) {
61            // まず、作成したディレクトリ内のファイルやサブディレクトリを削除します。
62            // `glob` で取得した各アイテムを安全に削除します。
63            foreach (glob($tempDir . '/*') as $item) {
64                if (is_file($item)) {
65                    unlink($item); // ファイルを削除
66                } elseif (is_dir($item)) {
67                    rmdir($item); // 空のディレクトリを削除
68                }
69            }
70            // すべてのコンテンツが削除された後、一時ディレクトリ自体を削除します。
71            rmdir($tempDir);
72            echo "一時ディレクトリ '" . $tempDir . "' とその内容を削除しました。" . PHP_EOL;
73        }
74    }
75}
76
77// 上記の関数を実行し、GlobIterator::getBasename() の動作を確認します。
78demonstrateGlobIteratorGetBasename();

GlobIterator::getBasename()は、ファイルパスからファイル名やディレクトリ名を抽出するメソッドです。これはPHPのグローバル関数basename()と同じく、GlobIteratorが返すSplFileInfoオブジェクトで利用できます。

引数$suffixはオプションで、ファイル名から除去したい拡張子を文字列で指定します。例えば、'document.txt'に対して'.txt'を指定すると'document'が返され、指定しない場合は拡張子を含む完全なファイル名が返されます。戻り値は常に文字列型で、抽出された名前を返します。

このサンプルコードでは、一時的なファイルとディレクトリを作成し、GlobIteratorでそれらを走査します。取得した各SplFileInfoオブジェクトからgetBasename()を呼び出し、引数$suffixの有無によるファイル名取得の違いを示しています。これにより、ファイルパスから目的の名前を取得する方法を理解できます。使用後、作成したデータは削除されます。

Copy
1<?php
2
3/**
4 * GlobIterator::getBasename() メソッドの使用例。
5 *
6 * このスクリプトは、一時的なファイルを作成し、GlobIterator を使用してそれらのファイルを検索します。
7 * その後、各ファイルに対して getBasename() メソッドを呼び出し、ファイル名（ベース名）を取得する方法を示します。
8 * 引数にサフィックスを指定して、ファイル名から特定の拡張子を除外する方法も示します。
9 */
10
11// サンプルコードで使用する一時ディレクトリとファイルを設定します。
12$tempDir = __DIR__ . '/temp_glob_basename_example';
13$file1 = $tempDir . '/document.txt';
14$file2 = $tempDir . '/image.jpeg'; // このファイルは検索パターンに含まれないことを示すため
15$file3 = $tempDir . '/script.php';
16$file4 = $tempDir . '/archive.tar.gz'; // 複数のサフィックスを持つファイル
17
18// 一時ディレクトリを作成します。
19if (!file_exists($tempDir)) {
20    mkdir($tempDir);
21}
22
23// テスト用のファイルを作成します。
24file_put_contents($file1, 'This is a document content.');
25file_put_contents($file2, 'Dummy image content.');
26file_put_contents($file3, '<?php echo "Hello PHP!";');
27file_put_contents($file4, 'Compressed archive content.');
28
29echo "--- GlobIterator::getBasename の使用例 ---\n\n";
30
31// GlobIterator を使用して、作成した一時ディレクトリ内のファイルを検索します。
32// '.txt', '.php', '.gz' 拡張子のファイルを対象とします。
33// FilesystemIterator::SKIP_DOTS を使用して '.' や '..' のような特殊なエントリを除外します。
34$iterator = new GlobIterator($tempDir . '/*.{txt,php,gz}', FilesystemIterator::SKIP_DOTS);
35
36if (!$iterator->valid()) {
37    echo "指定されたパターンに一致するファイルが見つかりませんでした。パターン: " . $tempDir . '/*.{txt,php,gz}' . "\n";
38} else {
39    echo "一時ディレクトリ内のファイルベース名:\n";
40    foreach ($iterator as $fileInfo) {
41        echo "  パス: " . $fileInfo->getPathname() . "\n";
42
43        // getBasename() メソッドを使用してファイル名（ベース名）を取得します。
44        // 引数なしの場合、完全なファイル名が返されます。
45        echo "    完全なファイル名: " . $fileInfo->getBasename() . "\n";
46
47        // 引数にサフィックスを指定すると、そのサフィックスがファイル名から除外されます。
48        // 例: '.php' 拡張子を除外
49        if ($fileInfo->getExtension() === 'php') {
50            echo "    拡張子 '.php' を除外: " . $fileInfo->getBasename('.php') . "\n";
51        }
52        // 例: '.txt' 拡張子を除外
53        elseif ($fileInfo->getExtension() === 'txt') {
54            echo "    拡張子 '.txt' を除外: " . $fileInfo->getBasename('.txt') . "\n";
55        }
56        // 例: 複数のサフィックスを持つファイルから '.gz' のみを除外
57        elseif ($fileInfo->getBasename() === 'archive.tar.gz') {
58            echo "    拡張子 '.gz' を除外: " . $fileInfo->getBasename('.gz') . "\n";
59            // 複数のサフィックスを除外するには、最も右のサフィックスから指定します。
60            echo "    拡張子 '.tar.gz' を除外: " . $fileInfo->getBasename('.tar.gz') . "\n";
61        }
62        echo "\n";
63    }
64}
65
66// 使用後の一時ファイルとディレクトリをクリーンアップします。
67// GlobIteratorのパターンに一致しないファイルもすべて削除します。
68unlink($file1);
69unlink($file2);
70unlink($file3);
71unlink($file4);
72rmdir($tempDir);
73
74echo "一時ファイルとディレクトリをクリーンアップしました。\n";
75
76?>

GlobIterator::getBasename()メソッドは、GlobIteratorクラスによって取得されたファイル情報から、そのファイルやディレクトリの純粋な名前（ベース名）を文字列として取得します。このメソッドは、ファイルパスからディレクトリ部分を取り除いた名前を返します。

引数$suffixはオプションであり、ファイル名から除外したい特定の文字列（通常はファイル拡張子）を指定する際に使用します。例えば、document.txtというファイルに対して引数なしでgetBasename()を呼び出すとdocument.txtが返されますが、getBasename('.txt')と指定すると.txt部分が除外されてdocumentという結果が得られます。指定されたサフィックスはファイル名の末尾に正確に一致した場合のみ除外され、大文字・小文字を区別します。

また、archive.tar.gzのように複数のドットとサフィックスを持つファイルの場合、getBasename('.gz')ではarchive.tarが、getBasename('.tar.gz')ではarchiveがそれぞれ返されるように、最も右側のサフィックスから指定することで除外できます。このメソッドは、ファイルパスの管理やファイル名のみを利用する処理において、非常に役立ちます。