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

getBasenameメソッドは、PHPのSplTempFileObjectクラスに属し、ファイルパスからファイル名部分を取得するメソッドです。SplTempFileObjectクラスは、メモリ上やシステムの一時ディレクトリに作成される一時ファイルをオブジェクトとして扱うためのものです。これは、ファイルシステム上に永続的に保存する必要のない一時的なデータ処理に利用されます。

このgetBasenameメソッドは、SplTempFileObjectインスタンスが内部的に管理している仮想的なパス情報から、ファイル名のみを抽出して返します。例えば、パスが「/path/to/document.txt」である場合、「document.txt」という文字列が戻り値として得られます。また、このメソッドはオプションで引数を受け付け、その引数に指定したサフィックス（拡張子）をファイル名から取り除くことも可能です。例えば、ファイル名が「report.pdf」で、引数に「.pdf」と指定すると、「report」という拡張子なしのファイル名を取得できます。

戻り値は常に文字列型で、取得したファイル名が返されます。この機能は、一時的に扱うファイルのようなデータから、純粋な名前部分だけを識別したり、表示したりする際に非常に役立ちます。特に、ファイルパス全体ではなく、ファイルの名前だけが必要な場面で簡潔に情報を取り出すことが可能です。SplTempFileObjectが物理的なファイルパスを持たない場合でも、このメソッドによって、ファイル名という概念を統一的に扱うことができます。

Copy
1<?php
2$tempFileObject = new SplTempFileObject();
3$basename = $tempFileObject->getBasename();
4?>

string $suffix = ''

• string $suffix = '': ファイル名の末尾に追加する文字列。デフォルトでは空文字列。

string

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