php8.5
/
Download
Home/ Manual/ bson / packedarray/ MongoDB\BSON\PackedArray::get

MongoDB\BSON\PackedArray::get

PHP function Edit on GitHub ✎

(mongodb >=1.16.0)

Returns the value of an index in the array

Description

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

Parameters

key (int)

The index to retrieve from the array.

Return Values

Returns the value associated with the given index. If the index is not present in the array, 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.

Errors/Exceptions

  • Throws MongoDB\Driver\Exception\RuntimeException if the index is not present in the array.

See Also

  • MongoDB\BSON\PackedArray::has
  • BSON Types

Source: reference/mongodb/bson/packedarray/get.xml · from the official PHP manual (php/doc-en)