1. class
  2. MongoDB
  3. \
  4. BSON
  5. \
  6. Document

Document

Since: 1.16.0

final class Document implements ArrayAccess, IteratorAggregate, Serializable (View source)

Methods

static Document
fromBSON(string $bson)

No description

static Document
fromJSON(string $json)

No description

static Document
fromPHP(array|object $value)

No description

mixed
get(string $key)

No description

Traversable
getIterator()

Retrieve an external iterator

bool
has(string $key)

No description

array|object
toPHP(array|null $typeMap = null)

No description

string
toCanonicalExtendedJSON()

No description

string
toRelaxedExtendedJSON()

No description

bool
offsetExists(TKey $offset)

No description

mixed
offsetGet(TKey $offset)

No description

void
offsetSet(TKey $offset, TValue $value)

No description

void
offsetUnset(TKey $offset)

No description

string
__toString()

No description

static Document
__set_state(array $properties)

No description

string|null
serialize()

String representation of object.

void
unserialize(string $data)

Constructs the object.

void
__unserialize(array $data)

No description

array
__serialize()

No description

Details

at line 13
final static Document fromBSON(string $bson)

No description

Parameters

string $bson

Return Value

Document

at line 15
final static Document fromJSON(string $json)

No description

Parameters

string $json

Return Value

Document

at line 17
final static Document fromPHP(array|object $value)

No description

Parameters

array|object $value

Return Value

Document

at line 19
final mixed get(string $key)

No description

Parameters

string $key

Return Value

mixed

at line 21
final Traversable getIterator()

Retrieve an external iterator

Return Value

Traversable

An instance of an object implementing Iterator or Traversable

Exceptions

Exception

at line 23
final bool has(string $key)

No description

Parameters

string $key

Return Value

bool

at line 25
final array|object toPHP(array|null $typeMap = null)

No description

Parameters

array|null $typeMap

Return Value

array|object

at line 27
final string toCanonicalExtendedJSON()

No description

Return Value

string

at line 29
final string toRelaxedExtendedJSON()

No description

Return Value

string

at line 32
bool offsetExists(TKey $offset)

Since: 1.17.0

No description

Parameters

TKey $offset

An offset to check for.

Return Value

bool

true on success or false on failure.

The return value will be casted to boolean if non-boolean was returned.

at line 35
mixed offsetGet(TKey $offset)

Since: 1.17.0

No description

Parameters

TKey $offset

The offset to retrieve.

Return Value

mixed

Can return all value types.

at line 38
void offsetSet(TKey $offset, TValue $value)

Since: 1.17.0

No description

Parameters

TKey $offset

The offset to assign the value to.

TValue $value

The value to set.

Return Value

void

at line 41
void offsetUnset(TKey $offset)

Since: 1.17.0

No description

Parameters

TKey $offset

The offset to unset.

Return Value

void

at line 43
final string __toString()

No description

Return Value

string

at line 45
final static Document __set_state(array $properties)

No description

Parameters

array $properties

Return Value

Document

at line 47
final string|null serialize()

String representation of object.

Return Value

string|null

The string representation of the object or null

Exceptions

Exception

at line 49
final void unserialize(string $data)

Constructs the object.

Parameters

string $data

The string representation of the object.

Return Value

void

at line 51
final void __unserialize(array $data)

No description

Parameters

array $data

Return Value

void

at line 53
final array __serialize()

No description

Return Value

array