CoolCMS API

MyWorkDetail extends BaseComponent

in package

• Application

uses InitTrait, SignalTrait, FormTrait

Detail of one job of the client: the job header, the table of work items and the expansion of one work item (persistent `$work`): description, hours/rate/price and the comment thread with a form for adding a message.

Table of Contents

Constants

ERROR_MESSAGE_KEYS  : array<string|int, mixed> = [2 => 'comments.form.messages.errors.validation...

`code` of the Api response (`mixed` because of `ReflectionException`) mapped to the translated message key.

Properties

$container  : Container

$routerDispatcher  : RouterDispatcher

$translator  : ITranslator

$work  : int|null

Expanded work item; `null` means only the job table without a work item detail.

$appContext  : AppContext

$componentParameters  : array<string, mixed>

$currencyContext  : CurrencyContext|null

$deviceDetector  : DeviceDetector|null

$languageContext  : LanguageContext|null

$localizationContext  : LocalizationContext|null

$settingContext  : SettingContext

$themeContext  : ThemeContext|null

$translatorDomain  : string|null

$itemsCache  : WorkSheet>, unreadComments: array}|null

Memoizes {@see WorkItemManager::findMyItems()} within one request, for the same reason as `$listsCache`: the guard "the chosen work item belongs to this job" of `prepareWorkDetail()` (see `InitTrait::fetchItems()`) needs the same data as the grouping by work sheet in `prepareDetail()`, and a signal/form success calls `prepareWorkDetail()` separately, possibly before `prepareDetail()`.

$listsCache  : WorkList>, totalCount: int, workItemCounts: array}|null

Memoizes {@see WorkListManager::findMyLists()} within one request; the comment form can be created before `render()` (a signal/form POST calls `createComponent*()` first), see `InitTrait::fetchLists()`.

$workItemManager  : WorkItemManager

$workListId  : int

Id of the displayed job; set by the presenter ({@see setWorkListId()}) after `actionDetail()`.

$workListManager  : WorkListManager

Methods

__call()  : mixed

Dispatches `renderXyz()` to `render('Xyz', ...$args)`.

__construct()  : mixed

createComponent()  : IComponent|null

getAppContext()  : AppContext

getComponentParameter()  : mixed

Returns a component parameter, or null when it is not set.

getContainer()  : Container

getCurrencyContext()  : CurrencyContext|null

getLanguageContext()  : LanguageContext|null

getLocalizationContext()  : LocalizationContext|null

getRouterDispatcher()  : RouterDispatcher

getSettingContext()  : SettingContext

getSettings()  : array<int, array<string, mixed>>

getThemeContext()  : ThemeContext|null

handleSelectWork()  : void

hasServiceByType()  : bool

Returns whether the container has a service of the given type.

initializeAllContexts()  : void

injectDeviceDetector()  : void

onCommentFormSuccess()  : void

onCreate()  : void

render()  : void

setAppContext()  : $this

setComponentParameter()  : void

Sets a component parameter.

setCurrencyContext()  : $this

setLanguageContext()  : $this

setLocalizationContext()  : $this

setSettingContext()  : $this

setThemeContext()  : $this

setup()  : void

setupAppContext()  : void

setWorkListId()  : self

typedComponent()  : T

Returns a subcomponent with a verified type.

createComponentCommentForm()  : Form

frontPresenter()  : BasePresenter|null

Returns the front presenter the component is attached to (null outside the front end or when detached).

getTranslator()  : ITranslator

setTemplateFile()  : void

setTranslator()  : self

belongsToCurrentList()  : bool

Tells whether the expanded work item belongs to the job `$this->workListId` (replaces the removed `WorkItem::getWorkListId()`, see {@see prepareWorkDetail()}). `myItems` returns only the work items of this job (the server verified ownership), so membership in the {@see fetchItems()} result is the answer.

createMultiplierComponent()  : Multiplier<string|int, IComponent>

Creates a multiplier for the component.

createNewComponentInstance()  : IComponent|null

Creates a new component instance without adding it to the presenter; used by the multiplier.

createStandardComponent()  : IComponent|null

Creates a standard component (not a multiplier).

fetchItems()  : WorkSheet>, unreadComments: array}

Returns `WorkItemManager::findMyItems()` memoized for the lifetime of this component instance, for the same reason as {@see fetchLists()}: the guard of `prepareWorkDetail()` ({@see belongsToCurrentList()}) can run before `render()` and `prepareDetail()` calls it again; without memoization that would be two bridge queries per request.

fetchLists()  : WorkList>, totalCount: int, workItemCounts: array}

Returns `WorkListManager::findMyLists()` memoized for the lifetime of this component instance (one request). Required because the comment form can be created before `render()` (a form POST calls `createComponent*()` first); same as {@see \App\UI\Front\Company\Components\BookingCalendarComponent\Traits\InitTrait::fetchAvailability()}.

findOwnedList()  : WorkList|null

Returns the owned job from `myList` by `$this->workListId`, or `null` (foreign or nonexistent).

groupItemsBySheet()  : array<int, WorkItem>, sumHours: string, sumPrice: string}>

Groups work items by work sheet for the template (sheet heading + its items + hours/price sum per group).

prepareDetail()  : void

prepareEmptyWorkDetail()  : void

prepareWorkDetail()  : void

resolveMessageKey()  : string

An unknown or missing code gives the generic message.

str()  : string

`ArrayHash` values are `mixed`; safely narrows to string (a non-string becomes empty).

sumGroupHours()  : string

Returns the hours sum of a group: the same value as shown on the row (`actualHours ?? estimatedHours`, {@see \App\UI\Front\Company\Components\MyWorkDetailComponent\Templates\Default\Sections\Items.latte}), so the sum matches the table above it.

sumGroupPrice()  : string