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

FilesystemIterator::CURRENT_MODE_MASK定数は、PHPのFilesystemIteratorクラスにおいて、イテレータがディレクトリ内の現在の要素をどのように表現して返すかというモードに関連するビットマスクを表す定数です。FilesystemIteratorは、ディレクトリの内容を反復処理する際に、各要素をパス名として扱う(CURRENT_AS_PATHNAME)、より詳細な情報を持つSplFileInfoオブジェクトとして扱う(CURRENT_AS_FILEINFO)、あるいはイテレータ自身として扱う(CURRENT_AS_SELF)といった複数の返却モードを選択できます。

このCURRENT_MODE_MASK定数は、これらのモード設定のみをまとめて識別するために使用されます。FilesystemIteratorの動作モードを制御するsetFlags()メソッドなどで、既存のフラグ設定の中から、特に現在の要素の返却形式に関する設定だけを抽出したり、変更したりする際に役立ちます。例えば、.や..をスキップするかどうか(SKIP_DOTS)といった他のフラグとは独立して、現在の要素の表現形式だけを柔軟に変更したい場合に利用します。

具体的には、CURRENT_MODE_MASKは、設定されている複数のフラグの中から、現在の要素の返却モードに関するフラグのみを取り出すための「フィルター」として機能します。これにより、開発者はFilesystemIteratorの様々な動作設定の中でも、特に要素の取得形式に関する部分を正確に指定し、既存の設定を意図せず変更してしまうリスクを避けながら、堅牢なコードを記述できるようになります。

Copy
1<?php
2
3$mask = FilesystemIterator::CURRENT_MODE_MASK;
4
5?>

引数なし

引数はありません

int

FilesystemIterator::CURRENT_MODE_MASK は、現在のファイルモードを表すビットマスクを整数値で返します。これは、FilesystemIterator の current() メソッドで返される値のモード部分を抽出するために使用されます。