EntityRepo<`T`>

Basic interface for entity services.

interface EntityRepo<T>

Copyright: 2015-2016 Appertly

License: Apache-2.0

Instance Methods

Public
Returns	Signature and Description
`int`	`countAll`(`ConstMap<string,mixed> $criteria`) Counts several records by some arbitrary criteria.
`Traversable`<`T`>	`findAll`(`ConstMap<string,mixed> $criteria`, `?Pagination $pagination = null`, `?bool $totalCount = false`) Finds several records by some arbitrary criteria.
`?T`	`findById`(`mixed $id`) Gets a single document by ID.
`?T`	`findOne`(`ConstMap<string,mixed> $criteria`) Finds a single record by some arbitrary criteria.
`T`	`get`(`mixed $id`) Gets a single document by ID, throwing an exception if it's not found.
`Traversable`<`T`>	`getAll`(`ConstVector<mixed> $ids`) Gets several documents by ID.
`ImmMap`<`string`,`T`>	`getInstanceMap`(`Traversable<T> $entities`) Gets a Map that relates identifier to instance
`string`	`getType`() Gets the type of entity produced, mainly for ACL reasons.

Method Details

countAll

abstract public function countAll(ConstMap<string,mixed> $criteria)

Counts several records by some arbitrary criteria.

Since: 0.6.0

Parameters
Name	Type	Description
`$criteria`	`ConstMap`<`string`,`mixed`>	Field to value pairs

Returns
Type	Description
`int`	The count of the documents

Throws
Type	Conditions
`Unreachable`	If the connection fails
`Unretrievable`	If the result cannot be returned
`Generic`	If any other database problem occurs

findAll

abstract public function findAll(ConstMap<string,mixed> $criteria, ?Pagination $pagination = null, ?bool $totalCount = false)

Finds several records by some arbitrary criteria.

Parameters
Name	Type	Description
`$criteria`	`ConstMap`<`string`,`mixed`>	Field to value pairs
`$pagination`	`?Pagination`	Optional pagination parameters
`$totalCount`	`?bool`	Return a `CursorSubset` that includes the total number of records. This is only done if `$pagination` is not using the defaults.

Returns
Type	Description
`Traversable`<`T`>	The objects found or null if none

Throws
Type	Conditions
`Unreachable`	If the connection fails
`Unretrievable`	If the result cannot be returned
`Generic`	If any other database problem occurs

findById

abstract public function findById(mixed $id)

Gets a single document by ID.

Parameters
Name	Type	Description
`$id`	`mixed`	The document identifier

Returns
Type	Description
`?T`	The entity

Throws
Type	Conditions
`Unreachable`	If the connection fails
`Unretrievable`	If the result cannot be returned
`Generic`	If any other database problem occurs

findOne

abstract public function findOne(ConstMap<string,mixed> $criteria)

Finds a single record by some arbitrary criteria.

Parameters
Name	Type	Description
`$criteria`	`ConstMap`<`string`,`mixed`>	Field to value pairs

Returns
Type	Description
`?T`	The object found or null if none

Throws
Type	Conditions
`Unreachable`	If the connection fails
`Unretrievable`	If the result cannot be returned
`Generic`	If any other database problem occurs

get

abstract public function get(mixed $id)

Gets a single document by ID, throwing an exception if it's not found.

Parameters
Name	Type	Description
`$id`	`mixed`	The document identifier

Returns
Type	Description
`T`	The entity

Throws
Type	Conditions
`Unreachable`	If the connection fails
`Unretrievable`	If the document doesn't exist
`Generic`	If any other database problem occurs

getAll

abstract public function getAll(ConstVector<mixed> $ids)

Gets several documents by ID.

Parameters
Name	Type	Description
`$ids`	`ConstVector`<`mixed`>	Array of identifiers

Returns
Type	Description
`Traversable`<`T`>	The results

Throws
Type	Conditions
`Unreachable`	If the connection fails
`Unretrievable`	If the result cannot be returned
`Generic`	If any other database problem occurs

getInstanceMap

abstract public function getInstanceMap(Traversable<T> $entities)

Gets a Map that relates identifier to instance

Parameters
Name	Type	Description
`$entities`	`Traversable`<`T`>	The entities to "zip"

Returns
Type	Description
`ImmMap`<`string`,`T`>	The instances keyed by identifier

getType

abstract public function getType()

Gets the type of entity produced, mainly for ACL reasons.

Returns
Type	Description
`string`	The entity type