MultipleIterator::key

登録されているイテレータインスタンスを取得する

説明

public array MultipleIterator::key()

登録されているイテレータインスタンスの key() の結果を取得します。

警告

この関数は、 現在のところ詳細な情報はありません。引数のリストのみが 記述されています。

パラメータ

この関数にはパラメータはありません。

戻り値

登録されているイテレータインスタンスの配列を返します。

エラー / 例外

イテレータが無効な場合には、RuntimeException をスローします (PHP 8.1.0 以降)。 また、モード MIT_NEED_ALL が設定されているときに、 アタッチされているイテレータの中にひとつでも無効なものがあった場合にも RuntimeException が発生します。

このメソッドを foreach から呼ぶと、 警告 "Illegal type returned" が発生します。

変更履歴

バージョン 説明
8.1.0 MultipleIterator::key が無効なイテレータを使って呼び出された場合に、 RuntimeException をスローするようになりました。 これより前のバージョンでは、false を返していました。

参考

  • MultipleIterator::current