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

getPathInfoメソッドは、SplFileInfoクラスに属し、現在のファイルまたはディレクトリが格納されている親ディレクトリの情報を、新たなSplFileInfoオブジェクトとして取得するメソッドです。

SplFileInfoクラスは、ファイルシステム上のパスやファイルに関する詳細な情報（ファイル名、サイズ、更新日時など）にアクセスするための機能を提供します。このgetPathInfoメソッドを使用すると、例えばあるファイルを表すSplFileInfoオブジェクトがあるとき、そのファイルが置かれているディレクトリ（親ディレクトリ）に関する情報を簡単に取得できます。

具体的には、元のSplFileInfoオブジェクトが表すパスから、末尾のファイル名やディレクトリ名を除いた「ディレクトリ部分」を抽出し、そのディレクトリパスを表す新しいSplFileInfoオブジェクトを返します。これにより、元のオブジェクトのファイル名や拡張子といった情報とは別に、そのファイルが存在するディレクトリの情報を独立して操作できるようになります。

例えば、/var/www/html/index.phpというパスを持つSplFileInfoオブジェクトに対してgetPathInfo()を実行すると、/var/www/htmlというパスを表すSplFileInfoオブジェクトが返されます。このメソッドは、ファイルシステムを階層的に探索したり、特定のディレクトリ配下のファイルをまとめて処理したりする際に非常に役立ち、コードの可読性と保守性を高めます。

Copy
1<?php
2$fileInfo = new SplFileInfo('/path/to/your/file.txt');
3$parentDirectoryInfo = $fileInfo->getPathInfo();

?string $class = null

• string|null $class = null: パス情報を取得したいクラス名を指定します。指定しない場合は、デフォルトのパス情報が取得されます。

SplFileInfo|null

SplFileInfo::getPathInfo メソッドは、ファイルパス情報を持つ SplFileInfo オブジェクト、またはパス情報が存在しない場合は null を返します。