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

getBasenameメソッドは、SplFileObjectオブジェクトが表すファイルやディレクトリのパスから、ディレクトリ部分を除いたファイル名、つまりベース名を取得するメソッドです。例えば、「/var/www/html/index.php」のようなパスを持つファイルに対してこのメソッドを呼び出すと、「index.php」という文字列が返されます。これにより、ファイルの実際の場所を気にせず、その名前だけを扱いたい場合に非常に便利です。

このメソッドは、オプションで一つの引数を受け取ります。この引数は、ファイル名から取り除きたいサフィックス（例えばファイルの拡張子）を指定するためのものです。例えば、「document.txt」というファイル名から「.txt」というサフィックスを除外して「document」という名前だけを取得したい場合、この引数に「.txt」を指定することができます。

ファイルシステムを扱うアプリケーションで、ファイル名をリストアップする際や、特定の命名規則に従ってファイルを識別・処理する際など、フルパスから必要なファイル名部分だけを抽出したい多様なシナリオで活用されます。取得される結果は常に文字列型です。このメソッドは、ファイルのパス情報を細かく操作する上で重要な機能を提供します。

Copy
1<?php
2$fileObject = new SplFileObject('/path/to/example/document.txt');
3$basename = $fileObject->getBasename();
4echo $basename;
5?>

string $suffix = ''

• string $suffix = '': ファイル名から除去する接尾辞を指定する文字列。デフォルトは空文字列で、何も除去しません。

string

SplFileObject::getBasename() は、ファイルパスから拡張子を除いたファイル名（ベース名）を文字列で返します。