DbRefResolver<`T`>

Resolves DbRef objects

interface DbRefResolver<T>

Instance Methods

Public
Returns	Signature and Description
`bool`	`isResolvable`(`string $ref`) Gets whether or not this class supports the reference type.
`?T`	`resolve`(`DbRef $ref`) Resolves a MongoDB DbRef.
`Traversable`<`T`>	`resolveAll`(`Traversable<DbRef> $refs`) Resolves a MongoDB DbRef.

abstract public function isResolvable(string $ref)

Gets whether or not this class supports the reference type.

Parameters
Name	Type	Description
`$ref`	`string`	The reference type (usually a MongoDB collection name)

Returns
Type	Description
`bool`	`true` if the reference type is supported

abstract public function resolve(DbRef $ref)

Resolves a MongoDB DbRef.

Parameters
Name	Type	Description
`$ref`	`DbRef`	The DbRef to load

Returns
Type	Description
`?T`	The loaded entity or `null` if not found

Throws
Type	Conditions
`InvalidArgumentException`	If `$ref` is of an unsupported type
`Unreachable`	If the connection fails
`Unretrievable`	If the result cannot be retrieved
`Generic`	If any other database problem occurs

abstract public function resolveAll(Traversable<DbRef> $refs)

Resolves a MongoDB DbRef.

Parameters
Name	Type	Description
`$refs`	`Traversable`<`DbRef`>	The DbRefs to load

Returns
Type	Description
`Traversable`<`T`>	The loaded entities

Throws
Type	Conditions
`InvalidArgumentException`	If any `$ref`s are of an unsupported type
`Unreachable`	If the connection fails
`Unretrievable`	If the result cannot be retrieved
`Generic`	If any other database problem occurs