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

setFlagsメソッドは、FilesystemIteratorオブジェクトがファイルシステムを走査する際の挙動を制御するためのフラグを設定するメソッドです。このメソッドを使用することで、イテレータがディレクトリ内のファイルをどのように扱うか、また各要素をどのような形式で返すかといった細かな設定を調整できます。

具体的には、.（カレントディレクトリ）や..（親ディレクトリ）といった特殊なドットファイルを走査対象からスキップするかどうか、シンボリックリンクを辿ってそのリンク先のファイルやディレクトリを対象とするか、あるいはイテレータが現在の要素をパス名として返すか、ファイル情報オブジェクトとして返すかなどを指定することが可能です。これらの挙動は、FilesystemIterator::SKIP_DOTSやFilesystemIterator::FOLLOW_SYMLINKS、FilesystemIterator::CURRENT_AS_PATHNAMEといったクラス定数として定義されています。

setFlagsメソッドの引数として、これらの定数をビット論理和演算子（|）で組み合わせて渡すことで、複数の挙動を同時に設定できます。これにより、FilesystemIteratorはファイルシステムを効率的かつ柔軟に処理するための強力なツールとなり、特定の要件に合わせたファイルやディレクトリの走査ロジックを容易に実装できるようになります。このメソッドは、ファイルシステムの操作におけるイテレータの挙動をきめ細かく制御するために不可欠な機能を提供します。

Copy
1<?php
2$iterator = new FilesystemIterator('/path/to/directory');
3$iterator->setFlags(FilesystemIterator::SKIP_DOTS | FilesystemIterator::KEY_AS_FILENAME | FilesystemIterator::CURRENT_AS_FILEINFO);
4?>

int $flags

• int $flags: FilesystemIterator の動作を制御するフラグの整数値

戻り値なし

戻り値はありません