array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'ja', ), 'this' => array ( 0 => 'multipleiterator.key.php', 1 => 'MultipleIterator::key', 2 => '登録されているイテレータインスタンスを取得する', ), 'up' => array ( 0 => 'class.multipleiterator.php', 1 => 'MultipleIterator', ), 'prev' => array ( 0 => 'multipleiterator.getflags.php', 1 => 'MultipleIterator::getFlags', ), 'next' => array ( 0 => 'multipleiterator.next.php', 1 => 'MultipleIterator::next', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'ja', 'path' => 'reference/spl/multipleiterator/key.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

MultipleIterator::key

(PHP 5 >= 5.3.0, PHP 7, PHP 8)

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

説明

public MultipleIterator::key(): array

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

警告

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

パラメータ

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

戻り値

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

エラー / 例外

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

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

変更履歴

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

参考