【PHP8.x】getFilenameメソッドの使い方
getFilenameメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
getFilenameメソッドは、ファイルまたはディレクトリのベース名、つまりファイル名部分を取得するメソッドです。このメソッドはPHPの組み込みクラスであるSplFileInfoに属しており、SplFileInfoはファイルやディレクトリのパスに関する情報を取り扱うためのオブジェクトを提供します。
SplFileInfoオブジェクトは、ファイルやディレクトリのパスを受け取って生成され、そのパスに関するさまざまな情報を取得できます。getFilenameメソッドを実行すると、指定されたパスからディレクトリ部分を除外し、純粋なファイル名(拡張子を含む)またはディレクトリ名のみを文字列として返します。
例えば、パスが/home/user/document/report.pdfである場合、「report.pdf」という文字列が返されます。また、パスが/var/www/htmlというディレクトリである場合は、「html」という文字列を取得できます。この機能は、特定のファイル名やディレクトリ名をフルパスから抽出したい場合に非常に有用です。
システムエンジニアを目指す方にとって、ファイル処理は多くのシステムで必要となる基本的な操作です。getFilenameメソッドは、アップロードされたファイルの元のファイル名を特定したり、ログファイルの命名規則に基づいてファイル名を分析したり、特定のファイル形式を識別したりする際に役立ちます。このように、ファイルシステムを操作するアプリケーションを開発する上で、パス情報を効果的に管理するための重要なツールの一つとして活用されます。返される値の型は常に文字列です。
構文(syntax)
1<?php 2$fileInfo = new SplFileInfo('path/to/example.txt'); 3$filename = $fileInfo->getFilename(); 4?>
引数(parameters)
引数なし
引数はありません
戻り値(return)
string
SplFileInfo::getFilename メソッドは、ファイルパスからファイル名部分を文字列として返します。