CoolCMS API

ServiceInterface
in

Contract of the front service layer.

$useCache on the read methods is the per-query wire-payload query cache policy. null means "no opinion": the Front repository passes it on unchanged and ApiBridge decides (request context, otherwise true); the Admin repository turns it into false (the admin always reads from the DB). It is set by ->useCache() on the query object.

T appears only in return positions, so it is covariant: XService (ServiceInterface<X>) is a subtype of ServiceInterface<BaseEntity>, so Manager<covariant BaseEntity, covariant ServiceInterface<BaseEntity>> accepts any concrete manager (DataGrid, tree components).

Tags
template-covariant

of BaseEntity = BaseEntity

Table of Contents

Methods

find()  : T|null
Finds one entity by id.
findAll()  : T[], 1: int}
Finds all entities matching the criteria.
findBy()  : T|null
Finds one entity by filters.
getTotalCount()  : int|null

Methods

find()

Finds one entity by id.

public find(int $id[, string|array<string|int, mixed> $includes = [] ][, bool|null $useCache = null ]) : T|null
Parameters
$id : int
$includes : string|array<string|int, mixed> = []
$useCache : bool|null = null
Return values
T|null

findAll()

Finds all entities matching the criteria.

public findAll([array<string|int, mixed> $filters = [] ][, array<string|int, mixed>|null $orderBy = null ][, int|null $offset = null ][, int|null $limit = null ][, array<string|int, mixed>|null $columns = null ][, bool $computeTotalCount = false ][, string|array<string|int, mixed> $includes = [] ][, bool|null $useCache = null ]) : T[], 1: int}
Parameters
$filters : array<string|int, mixed> = []
$orderBy : array<string|int, mixed>|null = null
$offset : int|null = null
$limit : int|null = null
$columns : array<string|int, mixed>|null = null
$computeTotalCount : bool = false
$includes : string|array<string|int, mixed> = []
$useCache : bool|null = null
Return values
T[], 1: int} —

[items, totalCount]

findBy()

Finds one entity by filters.

public findBy(array<string|int, mixed> $filters[, string|array<string|int, mixed> $includes = [] ][, bool|null $useCache = null ]) : T|null
Parameters
$filters : array<string|int, mixed>
$includes : string|array<string|int, mixed> = []
$useCache : bool|null = null
Return values
T|null

getTotalCount()

public getTotalCount() : int|null
Return values
int|null
On this page

Search results