MongoDB\BSON\PackedArray::offsetGet
Returns the value of an index in the array
Description
final public mixed MongoDB\BSON\PackedArray::offsetGet(mixed $key)
Parameters
-
key
-
The index to retrieve from the array. Only int is supported.
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\InvalidArgumentException on argument parsing errors.
- Throws MongoDB\Driver\Exception\RuntimeException if the index is not present in the array.
See Also
- ArrayAccess::offsetGet
- MongoDB\BSON\PackedArray::get