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

getPathInfoメソッドは、GlobIteratorクラスにおいて、現在イテレートしているファイルまたはディレクトリのパスに関する詳細な情報を取得するメソッドです。GlobIteratorは、指定されたパターンに合致するファイルシステム上のファイルやディレクトリを反復処理する際に利用されるクラスです。このメソッドを呼び出すと、現在処理中の項目についてのSplFileInfoオブジェクトが返されます。

SplFileInfoオブジェクトは、ファイルやディレクトリの様々な属性、例えばファイル名、親ディレクトリのパス、拡張子、ファイルの種類、最終更新日時、ファイルサイズなど、詳細なメタデータにアクセスするための標準的なインターフェースを提供します。getPathInfoメソッドが返すSplFileInfoオブジェクトを通じて、これらの情報を個別のメソッド（例: getFilename()、getExtension()、getPathname()など）を使用して取得することが可能です。

例えば、イテレータが特定のファイルに到達した際、getPathInfoメソッドを使用することで、そのファイルの拡張子を調べて特定の処理を行ったり、親ディレクトリの名前を取得してファイル整理に役立てたりできます。これは、ファイルパスから必要な要素を効率的に抽出・分析・操作する必要があるシステム開発において、非常に有用な機能となります。このメソッドは、ファイルやディレクトリに関する詳細な情報を、標準的かつ一貫した方法で提供するための強力な手段です。

Copy
1<?php
2
3$iterator = new GlobIterator(__FILE__);
4
5if ($iterator->valid()) {
6    $fileInfo = $iterator->getPathInfo();
7    echo $fileInfo->getFilename();
8}
9

?string $class = NULL

• string $class = NULL: GlobIteratorが対象とするクラス名。指定しない場合はすべてのクラスが対象となる。

SplFileInfo|false

GlobIterator::getPathInfo() メソッドは、現在のイテレータ位置にあるファイルまたはディレクトリのパス情報を SplFileInfo オブジェクトとして返します。ファイルやディレクトリが存在しない場合、あるいはパス情報が取得できない場合は false を返します。