【PHP8.x】CURRENT_AS_FILEINFO定数の使い方

CURRENT_AS_FILEINFO定数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

FilesystemIterator::CURRENT_AS_FILEINFO定数は、PHPのFilesystemIteratorクラスがファイルシステム内のファイルやディレクトリを順に処理する際に、現在の要素をどのような形式で提供するかを指定するための定数です。FilesystemIteratorは、特定のディレクトリ内の項目(ファイルやサブディレクトリ)を一つずつ見ていくための機能を提供します。

このCURRENT_AS_FILEINFO定数をFilesystemIteratorのオプションとして指定すると、イテレータが返す各要素がSplFileInfoオブジェクトのインスタンスとして扱われるようになります。SplFileInfoオブジェクトは、ファイルやディレクトリに関する詳細な情報(例えば、名前、パス、サイズ、最終更新日時、パーミッションなど)をカプセル化し、それらの情報にアクセスするための便利なメソッドを多数提供する標準的なクラスです。

例えば、SplFileInfoオブジェクトからは、それがファイルであるかディレクトリであるかを判断したり、ファイルのサイズを取得したり、更新日時を確認したりすることが容易に行えます。この定数を利用することで、ファイルシステムの情報をよりオブジェクト指向的に、そして柔軟にプログラム内で扱うことが可能になり、システムエンジニアがファイル操作を行うコードを効率的かつ堅牢に実装する上で非常に有用です。

構文(syntax)

1new FilesystemIterator('/path/to/directory', FilesystemIterator::CURRENT_AS_FILEINFO);

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

FilesystemIterator::CURRENT_AS_FILEINFO は、FilesystemIterator のインスタンスが現在指している要素を SplFileInfo オブジェクトとして取得するための定数です。この定数を FilesystemIterator::__construct()$flags 引数に指定することで、ファイル情報の取得方法を制御します。