MongoDB\BSON\PackedArray::offsetGet

(mongodb >=1.17.0)

MongoDB\BSON\PackedArray::offsetGet — Returns the value of an index in the array

Опис

final public MongoDB\BSON\PackedArray::offsetGet(mixed $key): mixed

Параметри

key: The index to retrieve from the array. Only int is supported.

Значення, що повертаються

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

Зауваження: 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.

Помилки/виключення

У разі помилки обробки параметрів викидається MongoDB\Driver\Exception\InvalidArgumentException.
Throws MongoDB\Driver\Exception\RuntimeException if the index is not present in the array.

Прогляньте також

ArrayAccess::offsetGet() - Offset to retrieve
MongoDB\BSON\PackedArray::get() - Returns the value of an index in the array

Improve This Page

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes

There are no user contributed notes for this page.