The MongoDB\BSON\Document class

Introduction

Represents a BSON document. This class is used when reading data as raw BSON and cannot be modified.

MongoDB\BSON\Document

final class MongoDB\BSON\Document implements MongoDB\BSON\Type, ArrayAccess, IteratorAggregate, Serializable {

/* Methods */

final private __construct()

final static public MongoDB\BSON\Document fromBSON(string $bson)

final static public MongoDB\BSON\Document fromJSON(string $json)

final static public MongoDB\BSON\Document fromPHP(objectarray $value)

final public mixed get(string $key)

final public MongoDB\BSON\Iterator getIterator()

final public bool has(string $key)

final public bool offsetExists(mixed $key)

final public mixed offsetGet(mixed $key)

final public void offsetSet(mixed $key, mixed $value)

final public void offsetUnset(mixed $key)

final public string serialize()

final public string toCanonicalExtendedJSON()

final public arrayobject toPHP(arraynull $typeMap = null)

final public string toRelaxedExtendedJSON()

final public string __toString()

final public void unserialize(string $data)

}

Version	Description
PECL mongodb 1.17.0	Implements MongoDB\BSON\Type.

Table of Contents

MongoDB\BSON\Document::__construct — Construct a new BSON document (unused)
MongoDB\BSON\Document::fromBSON — Construct a new document instance from a BSON string
MongoDB\BSON\Document::fromJSON — Construct a new document instance from a JSON string
MongoDB\BSON\Document::fromPHP — Construct a new document instance from PHP data
MongoDB\BSON\Document::get — Returns the value of a key in the document
MongoDB\BSON\Document::getIterator — Returns an iterator for the BSON document
MongoDB\BSON\Document::has — Returns whether a key is present in the document
MongoDB\BSON\Document::offsetExists — Returns whether a key is present in the document
MongoDB\BSON\Document::offsetGet — Returns the value of a key in the document
MongoDB\BSON\Document::offsetSet — Implementation of ArrayAccess
MongoDB\BSON\Document::offsetUnset — Implementation of ArrayAccess
MongoDB\BSON\Document::serialize — Serialize a Document
MongoDB\BSON\Document::toCanonicalExtendedJSON — Returns the Canonical Extended JSON representation of the BSON document
MongoDB\BSON\Document::toPHP — Returns the PHP representation of the BSON document
MongoDB\BSON\Document::toRelaxedExtendedJSON — Returns the Relaxed Extended JSON representation of the BSON document
MongoDB\BSON\Document::__toString — Returns the string representation of this BSON Document
MongoDB\BSON\Document::unserialize — Unserialize a BSON document