MongoDB\BSON\Iterator::key

(mongodb >=1.16.0)

MongoDB\BSON\Iterator::keyReturns the key of the current element

Description

public MongoDB\BSON\Iterator::key(): string|int

Liste de paramètres

Cette fonction ne contient aucun paramètre.

Valeurs de retour

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.

Erreurs / Exceptions

  • Lance une exception MongoDB\Driver\InvalidArgumentException lors d'une erreur survenue pendant l'analyse d'un argument.
  • Throws MongoDB\Driver\Exception\LogicException if the iterator is not valid.

Voir aussi

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top