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

FilesystemIterator::KEY_AS_PATHNAME定数は、FilesystemIteratorクラスがディレクトリ内の要素を反復処理する際に、各要素のキーとして完全なパス名を返すよう指定する定数です。

FilesystemIteratorは、ファイルシステムを効率的に走査するためのイテレータであり、ディレクトリ内のファイルやサブディレクトリを「キー」と「値」のペアとして処理します。この定数を設定すると、イテレータが返す要素の「キー」は、例えば /path/to/directory/filename.ext のような、ファイルやディレクトリのルートからの完全なパスになります。キーから対象のファイルやディレクトリのシステム上の位置を明確に把握したい場合に有用です。

この動作は、FilesystemIteratorのコンストラクタの第二引数、またはsetFlags()メソッドにこの定数を渡すことで有効にできます。例えば、特定のファイルパスに基づいて処理を分岐させたい場合や、キーとしてファイルシステムの絶対パスを利用してコレクションを構築したい場合に役立ちます。この定数は、他のキーの返却形式（例: ファイル名のみをキーとする KEY_AS_FILENAME など）と排他的に動作し、FilesystemIteratorの振る舞いを細かく制御するためのオプションの一つです。

Copy
1<?php
2new FilesystemIterator('/path/to/directory', FilesystemIterator::KEY_AS_PATHNAME);

引数なし

引数はありません

int

FilesystemIterator::KEY_AS_PATHNAME は、FilesystemIterator のイテレーションにおいて、キーとしてファイルまたはディレクトリの絶対パス名を取得することを指定する整数定数です。