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

keyメソッドは、GlobIteratorが現在指し示しているファイルやディレクトリの完全なパスを取得するメソッドです。このメソッドは、GlobIteratorが内部で管理している要素の「キー」を返します。プログラミングにおいて「キー」とは、データ構造内の特定の要素を一意に識別するための値であり、イテレータの場合は現在処理している要素の識別子となります。

GlobIteratorクラスは、ファイルシステム上で特定のパターン（例: *.txtやimages/*など）に合致するファイルやディレクトリを探索し、それらを順番に処理するための便利な機能を提供します。このクラスを使用すると、例えばあるディレクトリ内のすべての画像ファイルや、特定の拡張子を持つ設定ファイルを効率的に見つけ出し、一つずつプログラムで扱えるようになります。

keyメソッドは、GlobIteratorが現在アクセスしているファイルやディレクトリのフルパス（絶対パス）を文字列として返します。例えば、/home/user/documents/*.pdfというパターンでファイルを探索している際に、イテレータが/home/user/documents/report.pdfというファイルを見つけた場合、keyメソッドを呼び出すと、その完全なパス文字列である/home/user/documents/report.pdfが得られます。この情報は、見つかったファイルに対して何らかの操作（例えば、内容の読み込みやファイル名の変更、表示など）を行う際に、その対象を特定するために不可欠です。これにより、イテレータがどの要素を処理しているのかを明確に把握し、プログラムのロジックを正確に構築することができます。

Copy
1<?php
2$globIterator = new GlobIterator('/path/to/files/*');
3$currentKey = $globIterator->key();
4?>

引数なし

引数はありません

string

現在のイテレーションで $glob プロパティが保持しているファイルパスの文字列を返します。