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

keyメソッドは、DirectoryIteratorオブジェクトが現在指している要素のキーを取得するメソッドです。このメソッドは、ファイルシステム内のディレクトリを反復処理する際に、現在の要素がコレクション内で何番目であるかを示す数値インデックスを返します。

具体的には、DirectoryIteratorを使ってディレクトリの内容を一つずつ順番に処理する際、このkeyメソッドは、イテレーションの開始時には最初の要素に対して0を返します。その後、next()メソッドが呼び出されて次の要素に進むたびに、返される数値は自動的に1ずつ増えていきます。例えば、ディレクトリ内の最初のファイルが「file_a.txt」、次のディレクトリが「sub_dir」だった場合、key()は「file_a.txt」を処理している時に0を、次に「sub_dir」を処理している時に1を返します。

このkeyメソッドによって得られる値は、現在処理中のファイルやディレクトリ自体の名前やパスではなく、あくまでDirectoryIteratorが内部的に保持する処理順序を示すインデックスです。システム開発において、ディレクトリ内の要素を順番に処理する際に、現在の処理位置を把握したり、ループカウンタとして利用したりする場合にkeyメソッドは役立ちます。これにより、イテレータがどの段階にあるかを正確に識別し、より制御された形でディレクトリの内容を操作することが可能になります。

Copy
1$directoryIterator->key();

引数なし

引数はありません

int

DirectoryIterator::key() は、現在のディレクトリ内のエントリのキーを整数で返します。