CoolCMS API

MapperInterface
in

Api layer mapper contract; the methods come from the base {@see Mapper} through its traits.

The interface declares them so that services call them on a verified type. Tree operations live separately in TreeMapperInterface because only some mappers have them.

Tags
template-covariant

of BaseEntity = BaseEntity

Table of Contents

Methods

beginTransaction()  : void
commit()  : void
delete()  : Result
find()  : T|null
findAll()  : array{0: array, 1: int}
findBy()  : T|null
findRelatedIds()  : array<int, int>|null
getTransactionLevel()  : int
isInTransaction()  : bool
rollback()  : void
save()  : Result
updateAllRelations()  : Result
updateColumns()  : Result
updateRelations()  : Result

Methods

find()

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

findAll()

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>|null $includes = [] ]) : array{0: array, 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>|null = []
Return values
array{0: array, 1: int} —

[entities (or $columns rows), total count]

findBy()

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

findRelatedIds()

public findRelatedIds(int $parentId, string $property, string $targetAssociation) : array<int, int>|null
Parameters
$parentId : int
$property : string
$targetAssociation : string
Return values
array<int, int>|null —

null when metadata or the database failed

getTransactionLevel()

public getTransactionLevel() : int
Return values
int

isInTransaction()

public isInTransaction() : bool
Return values
bool

updateAllRelations()

public updateAllRelations(array<string|int, mixed> $parentEntityIds, string $property, array<string, mixed> $values) : Result
Parameters
$parentEntityIds : array<string|int, mixed>
$property : string
$values : array<string, mixed>
Return values
Result

updateColumns()

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

ids or composite-id arrays ([prop => value])

$values : array<string, mixed>

property name => new value

Return values
Result

updateRelations()

public updateRelations(array<string|int, mixed> $parentEntityIds, string $property, array<string|int, object> $relationEntities) : Result
Parameters
$parentEntityIds : array<string|int, mixed>
$property : string
$relationEntities : array<string|int, object>
Return values
Result
On this page

Search results