CoolCMS API

WorkListMapper extends ApiMapper
in package

FinalYes

`WorkList` is a job (historical name); `WorkSheet` is a work sheet inside a job.

Tags
extends

Table of Contents

Properties

$hydrator  : EntityHydrator
$repository  : WorkListRepository

Methods

__construct()  : mixed
archive()  : Result
delete()  : Result
deleteAll()  : Result
find()  : T|null
findAll()  : T>, 1: int}
findBy()  : T|null
invoicePreview()  : Result
invoiceSheets()  : Result
Thin pass-through to the repository; the `Result` is already built there (no entity to hydrate).
save()  : Result
unarchive()  : Result
updateColumns()  : Result
getEntityClass()  : T>
initalizeEntity()  : WorkList|null

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()

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|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> $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|null

invoicePreview()

public invoicePreview(int $id, array<int, int> $sheetIds) : Result
Parameters
$id : int
$sheetIds : array<int, int>
Return values
Result

invoiceSheets()

Thin pass-through to the repository; the `Result` is already built there (no entity to hydrate).

public invoiceSheets(int $id, array<int, int> $sheetIds, bool $createFollowUpSheet, string|null $followUpName) : Result
Parameters
$id : int
$sheetIds : array<int, int>
$createFollowUpSheet : bool
$followUpName : string|null
Return values
Result

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

unarchive()

public unarchive(int $id, string|null $reason) : Result
Parameters
$id : int
$reason : string|null
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

getEntityClass()

protected getEntityClass() : T>
Return values
T>

initalizeEntity()

protected initalizeEntity(array<string, mixed> $row) : WorkList|null
Parameters
$row : array<string, mixed>
Return values
WorkList|null
On this page

Search results