MongoHelper

Can be used by any class which accesses MongoDB.

trait MongoHelper

Instance Methods

Protected
Returns	Signature and Description
`Ta`	`ensure`<`Ta`>(`mixed $id`, `?Ta $document`) Makes sure a document isn't null.
`UTCDateTime`	`now`() Gets the current time.
`?UTCDateTime`	`toDate`(`mixed $date`) Tries to parse a date.
`ObjectID`	`toId`(`mixed $id`) Transforms a literal into a MongoDB ObjectId.
`ConstVector`<`ObjectID`>	`toIds`(`ConstVector<mixed> $ids`) Transforms literals into MongoDB ObjectIds.

protected function ensure<Ta>(mixed $id, ?Ta $document)

Makes sure a document isn't null.

Parameters
Name	Type	Description
`$id`	`mixed`	The document identifier, either a `\MongoDB\BSON\ObjectID` or string
`$document`	`?Ta`	The document to check

Returns
Type	Description
`Ta`	Returns `$document`

Throws
Type	Conditions
`Unretrievable`	if the document is null

protected function now()

Gets the current time.

Returns
Type	Description
`UTCDateTime`	The current time

protected function toDate(mixed $date)

Tries to parse a date.

Parameters
Name	Type	Description
`$date`	`mixed`	The possible string date value, a string, a `\DateTimeInterface`, or a `\MongoDB\BSON\UTCDateTime`

Returns
Type	Description
`?UTCDateTime`	The MongoDB datetime or null

protected function toId(mixed $id)

Transforms a literal into a MongoDB ObjectId.

Parameters
Name	Type	Description
`$id`	`mixed`	If it's an `ObjectID`, returns that, otherwise creates a new `ObjectID`.

Returns
Type	Description
`ObjectID`	The ObjectID

protected function toIds(ConstVector<mixed> $ids)

Transforms literals into MongoDB ObjectIds.

Parameters
Name	Type	Description
`$ids`	`ConstVector`<`mixed`>	Goes through each entry, converts to `ObjectID`

Returns
Type	Description
`ConstVector`<`ObjectID`>	The ObjectIDs