MongoDB\BSON\Document::offsetGet

(mongodb >=1.17.0)

MongoDB\BSON\Document::offsetGet — Retorna o valor de uma chave no documento

Descrição

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

Parâmetros

key: A chave a ser recuperada do documento.

Valor Retornado

Retorna o valor associado com a chave informada. Se a chave não estiver presente no documento, uma exceção é lançada.

Note: Ao encontrar um valor codificado como inteiro de 64 bits no documento BSON, o valor de retorno deste método será uma instância de MongoDB\BSON\Int64.

Erros/Exceções

Lança uma exceção MongoDB\Driver\Exception\InvalidArgumentException em caso de erro ao analisar argumentos.
Lança uma MongoDB\Driver\Exception\RuntimeException se a chave não estiver presente no documento.

Veja Também

ArrayAccess::offsetGet() - Posição a ser obtida
MongoDB\BSON\Document::get() - Retorna o valor de uma chave no documento