CoolCMS API

PrivilegeGroupService extends ApiService
in package

Privilege groups. `findAll()` is the standard SQL-side filter, sort and paging (ORM CrudTrait in the Api, {@see \App\UI\Api\System\Presenters\PrivilegeGroupPresenter}), extended by one extra read: the privilege count per group, which must be a SQL aggregation (`GROUP BY`), not a PHP count over loaded rows. It cannot join the single ORM query (computed column outside the mapped fields).

Tags
extends

Table of Contents

Properties

$mapper  : PrivilegeGroupMapper

Methods

__construct()  : mixed
delete()  : Result
deleteAll()  : Result
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.
getFilterOptions()  : array{modules: list, families: list}
getTotalCount()  : int|null
save()  : Result
updateColumns()  : Result

Properties

Methods

delete()

public delete(int|array<string|int, mixed> $id) : Result
Parameters
$id : int|array<string|int, mixed>
Return values
Result

deleteAll()

public deleteAll([array<string|int, mixed> $filters = [] ]) : Result
Parameters
$filters : array<string|int, mixed> = []
Return values
Result

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>|null $filters = [] ][, array<string|int, mixed>|null $orderBys = 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>|null = []
$orderBys : 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}

findBy()

Finds one entity by filters.

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

getFilterOptions()

public getFilterOptions() : array{modules: list, families: list}
Return values
array{modules: list, families: list}

getTotalCount()

public getTotalCount() : int|null
Return values
int|null

save()

public save(BaseEntity $entity[, array<string, mixed> $meta = [] ][, array<int, string> $skipFields = [] ]) : Result
Parameters
$entity : BaseEntity
$meta : array<string, mixed> = []
$skipFields : array<int, string> = []
Return values
Result

updateColumns()

public updateColumns(array<string|int, mixed> $ids, array<string, mixed> $values) : Result
Parameters
$ids : array<string|int, mixed>

ids or composite-id arrays

$values : array<string, mixed>

property name => new value

Return values
Result
On this page

Search results