MongoDB\BSON\Iterator
PHP マニュアル

MongoDB\BSON\Iterator::key

Returns the key of the current element

説明

public stringint MongoDB\BSON\Iterator::key()

パラメータ

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

戻り値

Returns the key of the current element. When iterating a BSON document, the key will always be a string. When iterating a BSON array, the key will be an int.

エラー / 例外

  • Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.
  • Throws MongoDB\Driver\Exception\LogicException if the iterator is not valid.

参考

  • Iterator::key