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

Copy
1<?php
2
3/**
4 * SplFileObject::getBasename() メソッドの使用例
5 *
6 * このスクリプトは、SplFileObject クラスを使用してファイルパスのベース名を取得する方法を示します。
7 * ベース名とは、ディレクトリパスや拡張子を除いたファイル名のことです。
8 * getBasename() メソッドは、PHP の basename() 関数に似ていますが、
9 * SplFileObject オブジェクトから直接呼び出される点が異なります。
10 * 引数 `$suffix` を指定することで、ファイル名から特定の拡張子を除外できます。
11 */
12function demonstrateSplFileObjectGetBasename(): void
13{
14    echo "--- SplFileObject::getBasename() の使用例 ---\n\n";
15
16    // 1. 基本的な使用例: ファイルパスからベース名を取得する
17    $filePath1 = '/var/www/html/index.php';
18    $fileObject1 = new SplFileObject($filePath1);
19    $basename1 = $fileObject1->getBasename();
20    echo "ファイルパス: '{$filePath1}'\n";
21    echo "ベース名 (引数なし): '{$basename1}'\n\n"; // 出力: index.php
22
23    // 2. 引数 `$suffix` を使用して拡張子を除外する
24    $filePath2 = '/home/user/documents/report.pdf';
25    $fileObject2 = new SplFileObject($filePath2);
26    $basename2 = $fileObject2->getBasename('.pdf');
27    echo "ファイルパス: '{$filePath2}'\n";
28    echo "ベース名 ('.pdf'を除外): '{$basename2}'\n\n"; // 出力: report
29
30    // 3. 複数の拡張子を持つファイルパスと `$suffix` の挙動
31    $filePath3 = '/tmp/archive.tar.gz';
32    $fileObject3 = new SplFileObject($filePath3);
33    $basename3a = $fileObject3->getBasename();
34    $basename3b = $fileObject3->getBasename('.gz');
35    $basename3c = $fileObject3->getBasename('.tar.gz');
36    echo "ファイルパス: '{$filePath3}'\n";
37    echo "ベース名 (引数なし): '{$basename3a}'\n";       // 出力: archive.tar.gz
38    echo "ベース名 ('.gz'を除外): '{$basename3b}'\n";      // 出力: archive.tar
39    echo "ベース名 ('.tar.gz'を除外): '{$basename3c}'\n\n"; // 出力: archive
40
41    // 4. ディレクトリパスがないファイル名の場合
42    $filePath4 = 'my_image.png';
43    $fileObject4 = new SplFileObject($filePath4);
44    $basename4 = $fileObject4->getBasename();
45    $basename4_no_ext = $fileObject4->getBasename('.png');
46    echo "ファイルパス: '{$filePath4}'\n";
47    echo "ベース名 (引数なし): '{$basename4}'\n";             // 出力: my_image.png
48    echo "ベース名 ('.png'を除外): '{$basename4_no_ext}'\n\n"; // 出力: my_image
49
50    echo "--- サンプルコード終了 ---\n";
51}
52
53// 関数を実行して、SplFileObject::getBasename() の動作を確認します。
54demonstrateSplFileObjectGetBasename();

PHP 8 の SplFileObject クラスに属する getBasename() メソッドは、ファイルパスからディレクトリ情報や特定の拡張子を除いた「ベース名」、つまり純粋なファイル名を取得するために使用されます。このメソッドは、SplFileObject オブジェクトから直接呼び出すことができるため、PHP標準の basename() 関数と似た役割を持ちながら、オブジェクト指向のアプローチでファイル情報を扱う際に便利です。

このメソッドには、オプションで $suffix という文字列型の引数を指定できます。 $suffix に例えば「.php」や「.pdf」のような拡張子を指定すると、取得されるベース名からその拡張子部分が除去されます。これにより、「report.pdf」というファイルパスからは「report」だけを、また「archive.tar.gz」というパスから「.gz」を指定すれば「archive.tar」を、さらに「.tar.gz」を指定すれば「archive」を取得することが可能です。

getBasename() メソッドは処理結果として、取得したベース名を文字列として返します。提供されたサンプルコードでは、様々なファイルパスに対してこのメソッドがどのように動作し、引数 $suffix を指定した場合としない場合でベース名がどのように変化するかが具体的に示されています。このメソッドを活用することで、ファイル名から不要な情報を手軽に取り除くことができます。

Copy
1<?php
2
3// このサンプルコードでは、SplFileObject クラスの getBasename メソッドの使い方を示します。
4// getBasename は、ファイルパスからファイル名（ベース名）を取得するために使用されます。
5
6// 1. デモンストレーション用に一時ファイルを作成します。
7//    実際のアプリケーションでは、既存のファイルパスを使用します。
8$tempFileName = 'my_document.txt';
9$tempFilePath = __DIR__ . DIRECTORY_SEPARATOR . $tempFileName;
10
11// ファイルの内容は getBasename メソッドの動作には影響しませんが、
12// ファイルが存在しないと SplFileObject はエラーになるため作成します。
13if (file_put_contents($tempFilePath, 'これはテストファイルの内容です。') === false) {
14    echo "エラー: 一時ファイルの作成に失敗しました。\n";
15    exit(1);
16}
17
18try {
19    // 2. SplFileObject のインスタンスを作成します。
20    //    これにより、ファイルがオブジェクトとして扱えるようになります。
21    $fileObject = new SplFileObject($tempFilePath, 'r');
22
23    // 3. getBasename() メソッドを引数なしで呼び出し、ファイル名全体を取得します。
24    //    この場合、ファイル名と拡張子（例: my_document.txt）が返されます。
25    $basenameWithExtension = $fileObject->getBasename();
26    echo "拡張子を含むファイルのベース名: " . $basenameWithExtension . "\n";
27
28    // 4. getBasename() メソッドに引数 (suffix) を指定して、
29    //    特定の拡張子を取り除いたファイル名を取得します。
30    //    この場合、ファイル名のみ（例: my_document）が返されます。
31    $basenameWithoutExtension = $fileObject->getBasename('.txt');
32    echo "拡張子 '.txt' を除去したファイルのベース名: " . $basenameWithoutExtension . "\n";
33
34} catch (RuntimeException $e) {
35    // SplFileObject のコンストラクタが失敗した場合（例: ファイルが見つからない場合）
36    // やファイル操作中にエラーが発生した場合に例外を捕捉します。
37    echo "エラー: ファイル操作中に問題が発生しました - " . $e->getMessage() . "\n";
38} finally {
39    // 5. デモンストレーション用に作成した一時ファイルを削除します。
40    //    try-catch ブロックの終了時に必ず実行されます。
41    if (file_exists($tempFilePath)) {
42        unlink($tempFilePath);
43    }
44}
45
46?>

SplFileObject::getBasename メソッドは、指定されたファイルパスからファイル名、つまりベース名を取得するために利用される機能です。このメソッドは SplFileObject クラスに属しており、ファイルパスをオブジェクトとして操作する際に、そのファイル自身の名前を抽出したい場合に特に役立ちます。

getBasename メソッドには、オプションで引数 $suffix を指定できます。引数を何も指定しない場合、メソッドはファイル名全体と拡張子を含む文字列を返します。例えば、「my_document.txt」のような形式で取得できます。

一方、引数 $suffix に特定の文字列（例えば、拡張子の「.txt」）を指定すると、メソッドはその文字列がファイル名の末尾にあれば、その部分を除去したベース名を返します。これにより、「my_document」のように拡張子を含まないファイル名を取得することが可能です。メソッドの戻り値は常に文字列型で、抽出されたファイル名が格納されています。

サンプルコードでは、まず一時的なファイルを作成し、それを SplFileObject のインスタンスとして開いています。そして、引数なしの場合と、引数に「.txt」を指定した場合の二通りの方法で getBasename を呼び出し、それぞれの結果として得られるファイル名を画面に表示しています。最終的に、デモンストレーション用に作成した一時ファイルは削除され、ファイルの操作中にエラーが発生した場合の例外処理も含まれています。