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

CURRENT_MODE_MASK定数は、PHPのGlobIteratorクラスに属し、ファイルシステムを反復処理する際に、現在処理中の要素（カレント要素）がどのような形式で返されるかを指定するモード設定に関連するビットマスクを表す定数です。

GlobIteratorは、特定のパターンに一致するファイルやディレクトリを効率的に検索し、それらを順次処理するための機能を提供します。この際、イテレータが各要素をどのように「表現」するか、例えば、ファイルに関する詳細な情報を持つオブジェクトとして取得するか、あるいは単にそのパス名として取得するかといった挙動を制御できます。

CURRENT_MODE_MASKは、具体的にGlobIterator::CURRENT_AS_FILEINFO（ファイル情報オブジェクトとして取得）、GlobIterator::CURRENT_AS_PATHNAME（パス名文字列として取得）、GlobIterator::CURRENT_AS_SELF（イテレータ自身として取得）といった、カレント要素の取得形式を決定するモード定数のグループを識別するためのものです。

これらのモード定数は、GlobIteratorオブジェクトのコンストラクタに引数として渡したり、setFlags()メソッドを通じて後から設定したりすることで、イテレータの動作を柔軟にカスタマイズするために利用されます。CURRENT_MODE_MASK定数自体が直接設定されることは稀ですが、これらのカレント要素の取得モードを指定する際に、どの設定が「現在の要素の形式」に関わるものかを識別するための内部的なマスクとして機能します。これにより、開発者は、ファイルシステムイテレーションのニーズに合わせて、返されるデータの形式を適切に選択できます。

Copy
1<?php
2echo GlobIterator::CURRENT_MODE_MASK;

引数なし

引数はありません

int

GlobIterator::CURRENT_MODE_MASK は、GlobIterator::getMode() メソッドで取得できる現在のモードを表すビットマスクの定数です。