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

setFlagsメソッドは、GlobIteratorオブジェクトの動作を制御するフラグを設定するメソッドです。GlobIteratorは、指定されたパターンに一致するファイルやディレクトリを繰り返し処理する際に利用されます。このsetFlagsメソッドを使用すると、イテレーション中にファイルやディレクトリをどのように扱うか、あるいはどの形式で情報を受け取るかといった詳細な挙動を定義できます。

引数として渡す $flags は整数値であり、GlobIteratorクラスが提供する特定の定数を組み合わせて指定します。例えば、GlobIterator::SKIP_DOTS定数を設定すると、特殊なディレクトリである「.」（カレントディレクトリ）と「..」（親ディレクトリ）がイテレーションの対象から除外されます。また、GlobIterator::CURRENT_AS_FILEINFO定数を使用すると、各要素をSplFileInfoクラスのオブジェクトとして取得できるようになり、ファイル名だけでなく、サイズ、更新日時、パーミッションなどの詳細情報に簡単にアクセスできます。

これらの定数は、ビット演算子 | を使って複数組み合わせることが可能で、一度に複数の設定を適用できます。これにより、隠しファイルを含めるか除外するか、ディレクトリ自体をイテレーションに含めるかなど、ファイル検索の条件を非常に柔軟に制御できます。このメソッドは、ファイルシステムを効率的に探索し、必要なデータだけを適切に処理するために不可欠な機能を提供します。setFlagsメソッドは値を返しません。

Copy
1<?php
2$iterator = new GlobIterator('./*.php');
3$iterator->setFlags(FilesystemIterator::SKIP_DOTS);

int $flags

• int $flags: GlobIterator の検索モードを設定するための整数フラグ

戻り値なし

戻り値はありません