【PHP8.x】getFileInfoメソッドの使い方
getFileInfoメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
getFileInfoメソッドは、PHPのSpl(Standard PHP Library)拡張にあるRecursiveDirectoryIteratorクラスに属し、現在のイテレータが指すファイルまたはディレクトリのSplFileInfoオブジェクトを返すメソッドです。
RecursiveDirectoryIteratorは、指定されたディレクトリとそのサブディレクトリの内容を再帰的に走査するためのイテレータです。このイテレータを使用すると、ファイルシステム内の特定の階層構造を持つファイルを効率的に処理できます。
getFileInfoメソッドは、RecursiveDirectoryIteratorが現在指し示しているファイルまたはディレクトリに関する詳細な情報を取得する際に利用されます。このメソッドを呼び出すと、ファイルパス、ファイル名、ファイルサイズ、最終変更日時、パーミッションなどの多様な属性を持つSplFileInfoクラスのインスタンスが返されます。SplFileInfoオブジェクトを使用することで、ファイルシステム関連のさまざまな操作や情報へのアクセスが標準化された方法で行えるため、コードの可読性と保守性が向上します。
例えば、特定のディレクトリ内のすべてのファイルについて詳細な情報を収集し、それらを条件に基づいてフィルタリングしたり、並べ替えたりするようなシナリオでgetFileInfoメソッドは非常に有用です。このメソッドは、ファイルやディレクトリの情報を取得するための、強力かつ柔軟な手段を提供し、システムエンジニアがファイルシステムを扱うプログラムを開発する上で不可欠な機能の一つと言えるでしょう。
構文(syntax)
1<?php 2$directoryIterator = new RecursiveDirectoryIterator('/path/to/directory'); 3$splFileInfoObject = $directoryIterator->getFileInfo(); 4?>
引数(parameters)
string $class = SplFileInfo::class
- string $class = SplFileInfo::class: 取得するファイル情報のクラスを指定する文字列。デフォルトは
SplFileInfo::classです。
戻り値(return)
SplFileInfo
このメソッドは、現在のディレクトリ項目に対応するSplFileInfoオブジェクトを返します。