【PHP8.x】getBasenameメソッドの使い方

getBasenameメソッドは、FilesystemIteratorオブジェクトが現在指しているファイルまたはディレクトリの基底名を取得するメソッドです。PHP 8で利用可能なこのメソッドは、ファイルやディレクトリの完全なパスから、ディレクトリのパス部分を除いた「純粋な名前」のみを取り出すことを目的としています。これは、例えば/var/www/html/index.phpというパスの項目からindex.phpという名前を取得するような機能です。

FilesystemIteratorは、指定されたディレクトリ内の各項目（ファイルやサブディレクトリ）を一つずつ順番に処理する際に使用されるオブジェクトです。このイテレータを使ってディレクトリを走査している最中に、現在処理している項目について、そのファイル名やディレクトリ名だけが必要な場合にgetBasenameメソッドが役立ちます。このメソッドはファイル名の拡張子を含む形で基底名を取得するため、ファイルのタイプを判断するなどの処理の前段階として利用できます。

システム開発において、特定の条件に合致するファイル名を抽出したり、ファイル名に基づいて何らかの処理を分岐させたりする場合など、ファイルシステムの操作が伴う多くのシナリオでこの機能は非常に有用です。特に、ユーザーがアップロードしたファイルの処理や、ログファイルの管理といった場面で、ファイル名の特定の部分にアクセスする必要がある際に、簡潔かつ正確に基底名を取得できるため、コードの可読性と保守性の向上に貢献します。

Copy
1<?php
2
3// FilesystemIterator クラスのインスタンスを作成します。
4// ここでは、現在のスクリプトがあるディレクトリを対象とします。
5$iterator = new FilesystemIterator(__DIR__);
6
7// getBasename メソッドを呼び出して、イテレータが指すパスの基底名を取得します。
8// 例えば、__DIR__ が '/var/www/html/my_project' であれば、'my_project' が取得されます。
9$basename = $iterator->getBasename();
10
11// 必要に応じて、拡張子（サフィックス）を指定して基底名から取り除くこともできます。
12// たとえば、イテレータが指すパスが '/path/to/archive.tar.gz' の場合に '.tar.gz' を取り除く場合：
13// $basenameWithoutSuffix = $iterator->getBasename('.tar.gz');
14

?string $suffix = null

• ?string $suffix = null: ファイル名の末尾に追加する文字列。指定しない場合は、ファイル名に接尾辞は追加されません。

string

FilesystemIterator::getBasenameは、現在のエントリのファイル名（拡張子なし）を文字列として返します。