MessageThreadMapper
extends ApiMapper
in package
FinalYes
Admin mapper that hydrates Api repository data into entities.
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- addParticipant() : Result
- delete() : Result
- deleteAll() : Result
- find() : T|null
- findAll() : T>, 1: int}
- findBy() : T|null
- removeParticipant() : Result
- save() : Result
- updateColumns() : Result
- getEntityClass() : T>
- initalizeEntity() : MessageThread|null
- toResult() : Result
- Converts an action response (`success` + `code`) to a {@see Result}. A gate rejection or an unknown shape becomes a generic failure.
Properties
$hydrator read-only
protected
EntityHydrator
$hydrator
$repository read-only
protected
MessageThreadRepository
$repository
Methods
__construct()
public
__construct(MessageThreadRepository $repository, EntityHydrator $hydrator) : mixed
Parameters
- $repository : MessageThreadRepository
- $hydrator : EntityHydrator
addParticipant()
public
addParticipant(int $threadId, int $userId) : Result
Parameters
- $threadId : int
- $userId : int
Return values
Resultdelete()
public
delete(int|array<string|int, mixed> $id) : Result
Parameters
- $id : int|array<string|int, mixed>
Return values
ResultdeleteAll()
public
deleteAll([array<string|int, mixed> $filters = [] ]) : Result
Parameters
- $filters : array<string|int, mixed> = []
Return values
Resultfind()
public
find(int $pageId[, string|array<string|int, mixed> $includes = [] ][, bool|null $useCache = null ]) : T|null
Parameters
- $pageId : int
- $includes : string|array<string|int, mixed> = []
- $useCache : bool|null = null
Return values
T|nullfindAll()
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()
public
findBy([array<string|int, mixed>|null $filters = [] ][, string|array<string|int, mixed> $includes = [] ][, bool|null $useCache = null ]) : T|null
Parameters
- $filters : array<string|int, mixed>|null = []
- $includes : string|array<string|int, mixed> = []
- $useCache : bool|null = null
Return values
T|nullremoveParticipant()
public
removeParticipant(int $threadId, int $participantId) : Result
Parameters
- $threadId : int
- $participantId : int
Return values
Resultsave()
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
ResultupdateColumns()
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
ResultgetEntityClass()
protected
getEntityClass() : T>
Return values
T>initalizeEntity()
protected
initalizeEntity(array<string, mixed> $row) : MessageThread|null
Parameters
- $row : array<string, mixed>
Return values
MessageThread|nulltoResult()
Converts an action response (`success` + `code`) to a {@see Result}. A gate rejection or an unknown shape becomes a generic failure.
private
toResult(array<int|string, mixed> $response) : Result
Parameters
- $response : array<int|string, mixed>