【PHP8.x】getBasenameメソッドの使い方
getBasenameメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
getBasenameメソッドは、DirectoryIteratorクラスで現在扱っているファイルまたはディレクトリのエントリから、その基本名(basename)を取得するメソッドです。このメソッドは、フルパスからディレクトリ部分を除いたファイル名やディレクトリ名のみを抽出します。例えば、/path/to/document.txtというエントリに適用すると、返り値はdocument.txtとなります。
getBasenameメソッドには、オプションとして$suffixという文字列型の引数を指定できます。この引数に除去したい拡張子などの文字列を指定することで、その部分を除いた基本名を取得することが可能です。具体的には、document.txtに対して$suffixに.txtを指定すると、返り値はdocumentとなります。これにより、拡張子を含まない純粋なファイル名を簡単に扱えます。
この機能は、ディレクトリ内のファイル一覧から名前だけを抜き出したい場合や、拡張子を除いた名前でファイルを処理したい場合など、システム開発におけるファイル管理の基本的な場面で幅広く活用されます。
構文(syntax)
1<?php 2$directory = new DirectoryIterator('.'); 3echo $directory->getBasename(); 4?>
引数(parameters)
?string $suffix = null
- ?string $suffix = null: 取得するベース名から除外する接尾辞(サフィックス)を指定します。指定しない場合は、ファイル名またはディレクトリ名のみが返されます。
戻り値(return)
string
DirectoryIterator::getBasename は、現在のディレクトリ要素のファイル名またはディレクトリ名(拡張子なし)を文字列として返します。