AbstractDaoService<`Ta`>

Abstract DAO-backed Service

abstract class AbstractDaoService<Ta> implements EntityRepo<Ta>

Copyright: 2015-2016 Appertly

License: Apache-2.0

Instance Properties

Protected
Name	Type	Summary
`$gatekeeper`	`Gatekeeper`

Constructors / Destructors

Public
Returns	Signature and Description
`void`	`__construct`(`Gatekeeper $gatekeeper`) Creates a new AbstractDaoService.

Instance Methods

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

Protected
Returns	Signature and Description
`Ta`	`getAndAssert`(`mixed $id`, `string $verb`) Gets the entity and asserts an ACL permission.
`EntityRepo`<`Ta`>	`getDao`() Gets the DAO.
`Ta`	`getForUpdate`(`mixed $id`) Gets the record, but tests the 'write' permission

Property Details

$gatekeeper

protected Gatekeeper $gatekeeper

Method Details

__construct

public function __construct(Gatekeeper $gatekeeper)

Creates a new AbstractDaoService.

Parameters
Name	Type	Description
`$gatekeeper`	`Gatekeeper`	The security gatekeeper

countAll

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

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`<`Ta`>	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

public function findById(mixed $id)

Gets a single document by ID.

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

Returns
Type	Description
`?Ta`	The entity

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

findOne

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
`?Ta`	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

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
`Ta`	The entity

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

getAll

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`<`Ta`>	The results

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

getAndAssert

protected function getAndAssert(mixed $id, string $verb)

Gets the entity and asserts an ACL permission.

Since: 0.5.1

Parameters
Name	Type	Description
`$id`	`mixed`	The entity id
`$verb`	`string`	The verb (e.g. 'read', 'write')

Returns
Type	Description
`Ta`	The entity

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

getDao

abstract protected function getDao()

Gets the DAO.

Returns
Type	Description
`EntityRepo`<`Ta`>	The backing DAO

getForUpdate

protected function getForUpdate(mixed $id)

Gets the record, but tests the 'write' permission

Deprecated: Since 0.5.1. Use `getAndAssert($id, 'write')` instead; Scheduled for removal in 1.0.0

Parameters
Name	Type	Description
`$id`	`mixed`	The entity id

Returns
Type	Description
`Ta`	The entity

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

getInstanceMap

public function getInstanceMap(Traversable<Ta> $entities)

Gets a Map that relates identifier to instance

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

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

getType

public function getType()

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

Returns
Type	Description
`string`	The entity type