array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'mongodb-bson-document.offsetget.php', 1 => 'MongoDB\\BSON\\Document::offsetGet', 2 => 'Returns the value of a key in the document', ), 'up' => array ( 0 => 'class.mongodb-bson-document.php', 1 => 'MongoDB\\BSON\\Document', ), 'prev' => array ( 0 => 'mongodb-bson-document.offsetexists.php', 1 => 'MongoDB\\BSON\\Document::offsetExists', ), 'next' => array ( 0 => 'mongodb-bson-document.offsetset.php', 1 => 'MongoDB\\BSON\\Document::offsetSet', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/mongodb/bson/document/offsetget.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

MongoDB\BSON\Document::offsetGet

(mongodb >=1.17.0)

MongoDB\BSON\Document::offsetGet — Returns the value of a key in the document

Description

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

Parameters

key
The key to retrieve from the document.

Return Values

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

Note: 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.

Errors/Exceptions

See Also