CoolCMS API

OrderStatusFormTrait

Edit/add form of an order status: behavior checkboxes (1:1 with {@see OrderStatus}), a cross-module select of the Invoicer invoice type ({@see \App\UI\Admin\Invoicer\Models\Managers\InvoiceTypeManager}) and multilingual texts including the e-mail template (`emailSubject`/`emailBody`, {@see OrderStatusText}).

key is immutable after creation: read-only on edit, free on add. The real guard runs in Api OrderStatusManager::beforeSave(); the form posts the unchanged value back, but the protection must live in the API.

Table of Contents

Methods

createComponentEditForm()  : Form
addOrderStatusBaseFields()  : void
`key` (read-only on edit) and the badge CSS class.
addOrderStatusBehaviorFields()  : void
Behavior checkboxes, 1:1 with the `OrderStatus` entity.
addOrderStatusTranslationFields()  : void
Multilingual fields: name and e-mail template (one set per language).
buildOrderStatusEntity()  : OrderStatus
loadOrderStatusSelectData()  : void
Form axes (Invoicer invoice types), once per request.
saveOrderStatusForm()  : bool
setOrderStatusFormDefaults()  : void

Methods

addOrderStatusBaseFields()

`key` (read-only on edit) and the badge CSS class.

private addOrderStatusBaseFields(Form $form) : void
Parameters
$form : Form

addOrderStatusBehaviorFields()

Behavior checkboxes, 1:1 with the `OrderStatus` entity.

private addOrderStatusBehaviorFields(Form $form) : void
Parameters
$form : Form

addOrderStatusTranslationFields()

Multilingual fields: name and e-mail template (one set per language).

private addOrderStatusTranslationFields(Form $form) : void
Parameters
$form : Form

loadOrderStatusSelectData()

Form axes (Invoicer invoice types), once per request.

private loadOrderStatusSelectData() : void

saveOrderStatusForm()

private saveOrderStatusForm(ArrayHash<string|int, mixed> $values) : bool
Parameters
$values : ArrayHash<string|int, mixed>
Return values
bool
On this page

Search results