MongoDB\BSON\Document::offsetGet

Returns the value of a key in the document

説明

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

パラメータ

key

The key to retrieve from the document.

戻り値

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

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

エラー / 例外

  • Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.
  • Throws MongoDB\Driver\Exception\RuntimeException if the key is not present in the document.

参考

  • ArrayAccess::offsetGet
  • MongoDB\BSON\Document::get