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

keyメソッドは、RecursiveDirectoryIteratorクラスにおいて、現在イテレータが指し示している要素のキーを取得するメソッドです。RecursiveDirectoryIteratorは、指定されたディレクトリとその中のサブディレクトリを、一つずつ順番に処理していくための機能を提供します。このメソッドが実行されると、イテレータが現在対象としているファイルまたはディレクトリのパスが文字列として返されます。

このパスは、RecursiveDirectoryIteratorがディレクトリツリーを走査している際に発見した各要素を、それぞれ一意に識別するための「名前」や「場所」として機能します。例えば、あるディレクトリとそのサブディレクトリ内に存在するすべてのファイルの正確な場所を知りたい場合や、特定のファイルパスに基づいて処理を行いたい場合に、keyメソッドから取得した情報が利用されます。PHPのイテレータ機能における基本的なメソッドの一つであり、ループ処理中に現在どの要素に注目しているかを特定するために不可欠です。戻り値は常に文字列型であり、現在のエントリへのパス表現を提供することで、システムエンジニアがディレクトリ構造内のデータを効率的に操作・管理する手助けをします。

Copy
1<?php
2
3$iterator = new RecursiveDirectoryIterator('/path/to/directory');
4$key = $iterator->key();
5
6?>

引数なし

引数はありません

string

RecursiveDirectoryIterator::key()メソッドは、現在イテレータが指しているディレクトリまたはファイルのパスを文字列で返します。