【PHP8.x】GlobIterator::getFileInfo()メソッドの使い方
getFileInfoメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
getFileInfoメソッドは、GlobIteratorクラスに属するメソッドで、現在のイテレータが指し示す項目(ファイルまたはディレクトリ)の情報を取得します。GlobIteratorは、指定されたパターンに一致するファイルやディレクトリのパスを繰り返し処理するために使用されますが、このgetFileInfoメソッドを利用することで、単なるパス文字列だけでなく、その項目に関する詳細な属性にアクセスできるようになります。
具体的には、PHPの標準クラスであるSplFileInfoオブジェクトを返します。SplFileInfoオブジェクトは、ファイルの絶対パス、ファイル名、サイズ、最終更新日時、パーミッション、ファイルタイプ(通常ファイルかディレクトリか)、読み取り・書き込み権限など、ファイルシステム上の項目に関する豊富な情報を提供します。
このメソッドを使用することで、GlobIteratorで取得した各ファイルやディレクトリに対して、その詳細な属性に基づいて様々な処理を実行することが可能になります。例えば、特定の条件(ファイルサイズ、更新日時、ファイルタイプなど)に合致する項目のみをフィルタリングしたり、その情報を表示したりする際に非常に役立ちます。ファイルシステムを効率的に走査し、各要素の情報を柔軟に扱いたい場合に、getFileInfoメソッドは強力なツールとなります。
構文(syntax)
1<?php 2$iterator = new GlobIterator(__DIR__ . '/*.txt'); 3$fileInfo = $iterator->getFileInfo(); 4?>
引数(parameters)
string $class = RecursiveDirectoryIterator::class
- string $class = RecursiveDirectoryIterator::class: ファイル情報を取得する際に使用するクラスを指定します。デフォルトは
RecursiveDirectoryIterator::classです。
戻り値(return)
SplFileInfo
GlobIterator::getFileInfo()メソッドは、現在のディレクトリ要素の情報を持つSplFileInfoオブジェクトを返します。このオブジェクトを通じて、ファイル名やパス、パーミッションなどの詳細情報を取得できます。