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

KEY_AS_FILENAME定数は、PHPのRecursiveDirectoryIteratorクラスにおいて、イテレータがディレクトリ内の要素を走査する際に、連想配列のキーとしてファイル名を使用するよう指示するための定数です。

RecursiveDirectoryIteratorは、指定されたディレクトリとそのサブディレクトリの内容を再帰的に反復処理するためのクラスです。通常、このイテレータをforeachループなどで使用すると、各要素のキーとしては要素のフルパス（例: /path/to/directory/file.txt）が返されます。

しかし、このKEY_AS_FILENAME定数をRecursiveDirectoryIteratorのコンストラクタの第二引数として指定することで、イテレータの挙動を変更できます。具体的には、キーとしてフルパスではなく、その要素のファイル名またはディレクトリ名のみ（例: file.txt）が返されるようになります。

この定数を利用することで、特定のファイル名やディレクトリ名に基づいて処理を行いたい場合や、キーとしてパス全体よりも簡潔な情報が必要な場合に、より直感的で読みやすいコードを記述できます。例えば、foreachループで$filename => $fileInfoObjectのようにアクセスしたい場合に役立ちます。

システムエンジニアを目指す初心者の方々にとって、ファイルシステムを扱う際のキーの形式を柔軟に選択できることは、さまざまな要件に対応するための重要な知識となります。この定数は、ディレクトリ構造を扱うプログラムの柔軟性と保守性を高めるために活用できる便利な機能の一つです。

Copy
1<?php
2
3$iterator = new RecursiveDirectoryIterator('/path/to/directory', RecursiveDirectoryIterator::KEY_AS_FILENAME);
4
5foreach ($iterator as $filename => $fileinfo) {
6    echo $filename . "\n";
7}

引数なし

引数はありません

int

RecursiveDirectoryIterator::KEY_AS_FILENAME は、ディレクトリ内の各要素のキーとしてファイル名（文字列）を返すことを示す整数定数です。