MongoDB\BSON\PackedArray::get

(mongodb >=1.16.0)

MongoDB\BSON\PackedArray::getReturns the value of an index in the array

Description

finalpublicMongoDB\BSON\PackedArray::get(int$key): mixed

Liste de paramètres

key (int)

The index to retrieve from the array.

Valeurs de retour

Returns the value associated with the given index. If the index is not present in the document, an exception is thrown.

Note: When encountering a value encoded as 64-bit integer in the BSON array, the return value of this method will be a MongoDB\BSON\Int64 instance.

Erreurs / Exceptions

  • Lance une exception MongoDB\Driver\InvalidArgumentException lors d'une erreur survenue pendant l'analyse d'un argument.
  • Throws MongoDB\Driver\Exception\RuntimeException if the index is not present in the array.

Voir aussi

To Top