CoolCMS API

ShipperTariffEdit extends BaseComponent

in package

• Application

uses AdminComponentFormTrait, FormTrait, FormHelpersTrait, BranchTrait

Add / edit form of a shipper tariff, hosted in the modal of {@see ShipperPresenter} (tab with the tariff list and modal editing; a `Multiplier<ShipperTariffEdit>` keyed by a persistent active key).

Table of Contents

Constants

EDIT_INCLUDES  : array<int, string> = [ 'translations', 'shipper', 'shipperRegion', '...

Canonical includes list, the single source of truth for loading the edited tariff.

Properties

$container  : Container

$routerDispatcher  : RouterDispatcher

$translator  : ITranslator

$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

$adminLanguageManager  : LanguageManager

$currencyManager  : CurrencyManager

$editedShipperTariff  : ShipperTariff|null

Edited tariff (null when adding); see {@see resolveEditedTariff()}.

$editingBranchId  : int|null

Branch currently edited in the modal (`branchId`); null when adding a new one.

$formActionsFactory  : FormActionsFactory

$formNotices  : array<int, array{type: string, key: string}>

Result-level messages of saving the tariff, rendered directly in the modal content.

$langNavFactory  : LangNavFactory

$paymentMethodManager  : PaymentMethodManager

$shipperId  : int

Edited shipper (server-side context, never taken from the form).

$shipperRegionManager  : ShipperRegionManager

$shipperTariffBandErrors  : array<int, string>

Band validation errors collected while building; `saveShipperTariffForm()` uses them to decide whether saving is allowed at all.

$shipperTariffBandWarnings  : array<int, string>

$shipperTariffCurrencies  : array<int, Currency>

$shipperTariffCurrentAxisDates  : array{prices: ?string, payments: ?string}|null

Date of the currently valid generation of each axis (per-request cache), see {@see getShipperTariffCurrentAxisDates()}.

$shipperTariffGenerationPrefill  : array{bands: list>, payments: array}|null

Prefill for a newly added generation; computed once per request and applied to every empty container that `onCreate` meets.

$shipperTariffManager  : ShipperTariffManager

$shipperTariffPaymentMethods  : array<int, PaymentMethod>

$shipperTariffRegionOptions  : array<int, NotTranslate>

$shipperTariffSupplyKindOptions  : array<int, string>

$shipperTariffVatOptions  : array<int, NotTranslate>

$supplyKindManager  : SupplyKindManager

$tariffId  : int|null

$vatManager  : VatManager

Methods

__call()  : mixed

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

__construct()  : mixed

canRemoveShipperTariffGeneration()  : bool

Tells whether a generation may be removed: only a new or scheduled one (from today's midnight on). The currently valid one may not, because deleting it would make an older generation take over, a silent return to old prices.

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

getShipperTariffBandIssues()  : array<int, array{type: string, from: string, to: string}>

Returns the strips between bands, as `['overlap' => range]` or `['gap' => range]` keyed by the index of the band before which the strip is rendered. It is computed on a sorted copy but returns the index in the submitted order, so the template reorders nothing.

getShipperTariffGenerationBadgeKey()  : string

Returns the badge key of the card header. With migrated data the axes diverge (the price list is valid from another date than the matrix), giving two "current" cards, so the badge says which axis the card holds.

getShipperTariffGenerationState()  : string

Returns `current` (valid now), `scheduled` or `history`, for the badge and card color.

getShipperTariffGenerationSummary()  : array{bands: int, currencies: int, methods: int}

Returns the card header summary: number of bands, number of currencies with at least one price, and number of available payment methods.

getThemeContext()  : ThemeContext|null

handleAddBranch()  : void

handleDeleteBranch()  : void

Deletes a branch over AJAX (no redirect, which would close the open tariff modal).

handleEditBranch()  : void

hasServiceByType()  : bool

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

initializeAllContexts()  : void

injectDeviceDetector()  : void

isShipperTariffGenerationDateLocked()  : bool

Tells whether the "valid from" field is locked: for history (fully read-only) and for the currently valid generation, whose values are editable but whose date is a fact; repricing from another date is a new generation. A disabled input is not posted, the build takes the date from `origDateFrom`.

isShipperTariffGenerationOpenByDefault()  : bool

Tells whether the card's `<details>` is open by default: a new generation (empty `origDateFrom`) is open because it is being worked on; all others (valid, scheduled, history) are collapsed.

isShipperTariffGenerationReadOnly()  : bool

Tells whether a generation is read-only. Only superseded history is: a generation before today's midnight that a newer one has replaced on its axis. The currently valid generation (even dated in the past) is editable, and a new one (empty `origDateFrom`) is always editable.

onBranchFormSuccess()  : void

onCreate()  : void

render()  : void

restoreShipperTariffGenerationDisplay()  : void

Restores the display of fields that do not survive a POST followed by an AJAX redraw. The template calls it via `{do}` first in every generation card (before totals are computed).

setAppContext()  : $this

setComponentParameter()  : void

Sets a component parameter.

setCurrencyContext()  : $this

setLanguageContext()  : $this

setLocalizationContext()  : $this

setSettingContext()  : $this

setThemeContext()  : $this

setup()  : void

setupAppContext()  : void

shipperTariffCurrencyHasPrice()  : bool

Tells whether the currency has a price in at least one band of this generation. Used only by {@see getShipperTariffGenerationSummary()} for the currency count; the template lists all currencies for every band regardless.

typedComponent()  : T

Returns a subcomponent with a verified type.

createAdminComponentForm()  : Form

createComponentAdminFormActions()  : FormActions

Creates the save / back buttons of the form.

createComponentAdminLangNav()  : LangNav

Creates the language tabs of the multilingual fields.

createComponentBranchForm()  : Form

createComponentEditForm()  : Form

currentLangId()  : int|null

Returns the current language id (for select captions etc.), null when unknown.

frontPresenter()  : BasePresenter|null

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

getFormLanguages()  : array<int, Language>

Returns the languages for multilingual form fields (admin `LanguageManager`, constructor-injected).

getTranslator()  : ITranslator

intOrNull()  : int|null

Converts a mixed form value to an int or null (an empty or zero value becomes null).

setTemplateFile()  : void

setTranslator()  : self

str()  : string

Converts a mixed form value to a string; non-scalars become an empty string.

strOrNull()  : string|null

Converts a mixed form value to a string or null (an empty string is stored as null).

addShipperTariffBandControls()  : void

Fields of one weight band inside a generation (currency becomes a table row in the template).

addShipperTariffGenerationMultiplier()  : void

Adds the outer `generations` multiplier, the nested `bands` multiplier and the fixed payment matrix.

addShipperTariffMainFields()  : void

addShipperTariffPaymentMatrixControls()  : void

Adds the payment matrix of a generation: a fixed 2D loop (methods x currencies), not a multiplier, because both axes are code lists that admins do not create in this form.

addShipperTariffTranslationFields()  : void

applyShipperTariffGenerations()  : void

Rebuilds both time series of the tariff from the submitted generations.

buildAfterSave()  : callable

Builds the post-save action (`AdminComponentFormTrait` hook); never redirects the page for AJAX.

buildBranchModalContent()  : string

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

Builds the band rows of one generation, sorted by `weightFrom` and renumbered (sorting happens on load only).

buildShipperTariffEntity()  : ShipperTariff

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

Maps the existing series to default rows of the outer multiplier.

buildShipperTariffGenerationRowForDate()  : array<string, mixed>

Builds the row of one generation (bands plus payment matrix) for a specific date; shared by {@see buildShipperTariffGenerationDefaultRows()} and {@see duplicateShipperTariffGeneration()}.

buildShipperTariffPaymentMatrixRow()  : array<string, mixed>

Maps the payment matrix cells of one generation to `pmAvailable_<mid>`, `pmPrice_<mid>_<cid>` and `pmFreeFrom_<mid>_<cid>`. Shared by {@see buildShipperTariffGenerationDefaultRows()} (existing generation) and {@see resolveShipperTariffGenerationPrefill()} (prefill of a new one).

canManageBranches()  : bool

Branches can be managed only on an already saved tariff (the foreign key target must exist).

collectShipperTariffBands()  : array<int, array{weightFrom: string, weightTo: ?string, row: array}>

Extracts and validates the bands of one generation. The returned order is the submitted order, not the sorted one: validation runs on a sorted copy so that error messages can name the exact range while the user's rows are not rearranged.

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

decimalOrNull()  : string|null

NOTE: this is not a duplicate of {@see \App\Core\Utils\Helpers\Decimal::fromInput()}. It quantizes to a given number of decimal places (`$scale`) instead of normalizing input. The scale differs per column (weight vs. shipping price), so it does not belong in the shared helper, which deliberately knows no scale so it cannot be unified across modules by accident.

duplicateShipperTariffGeneration()  : Container|null

Handles the "duplicate" action in the card header: copies the whole stored generation (bands and matrix) into a new generation so the admin only adjusts the date and prices.

entityReference()  : Shipper

Builds a thin shipper reference (the hydrator assembles the entity from the id).

fillShipperTariffGenerationContainer()  : void

Fills a generation container with row data (format of {@see buildShipperTariffGenerationRowForDate()}) so that it also works on a submitted form; the only reliable path for the AJAX actions "add generation" (prefill) and "duplicate".

findBranch()  : ShipperTariffBranch|null

flashBranchGuardError()  : void

formatBranchAddress()  : string

getShipperTariffCurrentAxisDates()  : array{prices: ?string, payments: ?string}

Returns the date of the currently valid generation of each axis separately (the greatest `date_from <= now`) in the `Y-m-d H:i:s` format that the hidden `origDateFrom` carries.

httpRequest()  : IRequest

Returns the HTTP request through the presenter; a control, unlike a presenter, has no `getHttpRequest()`.

isOwnEditFormSubmit()  : bool

Tells whether this request is a POST submit of this very `editForm`. The `_do` value carries the full component path, so a component created after the key switch has a different path and safely gets defaults.

isShipperTariffGenerationEmpty()  : bool

Detects a new empty container by the absence of data, not by index: `onCreate` runs for all generation containers on every request, including history and half-edited generations after a redraw. Empty `origDateFrom` alone is not enough (a new generation has it empty even after the admin typed something), so all fields the prefill would overwrite are checked too.

isShipperTariffHistoric()  : bool

loadBranchRows()  : array<int, array{id: int, name: string, address: string, active: bool}>

Builds the branch cards, always filtered by `isManaged`: `false` is reserved for a future bulk sync of an external shipper network and is never listed in the admin.

loadShipperTariffSelectData()  : void

Loads the form axes (regions, VAT rates, currencies, payment methods) once per request; called from `createComponentEditForm()` before the fields and defaults are built.

prefillNewShipperTariffGeneration()  : void

Prefills a newly added generation with the data of the currently valid one. Leaves `validFrom` and `origDateFrom` alone: empty `origDateFrom` marks a new generation for rendering and the immutability guard, and `validFrom` must be chosen deliberately by the admin.

redrawBranchesAfterMutation()  : void

redrawTariffModal()  : void

Redraws the host snippet `tariffEditHost` after an AJAX validation or save failure. The component renders again with the same submitted form (inline field errors) plus flash, and the modal stays open.

resolveEditedTariff()  : ShipperTariff|null

Loads the edited tariff, or returns null when adding.

resolveShipperTariffGenerationDate()  : DateTime|null

Converts `validFrom` to a `DateTime`. Empty means effective immediately (now). A past date would write into history, so it is an error, not a silent shift to today.

resolveShipperTariffGenerationPrefill()  : array{bands: list>, payments: array}

Resolves the prefill data of a new generation. Bands and the payment matrix are looked up separately because they are two independent time series ({@see ShipperTariff}).

resolveShipperTariffPrefillDate()  : DateTime|null

Resolves the generation date for the prefill: the greatest `date_from <= now` (the currently valid generation), or the nearest future one when the whole price list is only scheduled.

saveShipperTariffForm()  : bool

setBranchFormDefaults()  : void

setShipperTariffFormDefaults()  : void

shipperPresenter()  : ShipperPresenter|null

Returns the host presenter (the only consumer of this component), or null for any other.

shipperTariffBandContainers()  : array<int, Container>

shipperTariffControlValue()  : mixed

Returns a container control's value without type juggling over `IComponent` (which has no `getValue()`).

shipperTariffPaymentMethodRef()  : PaymentMethod

Builds a thin payment method reference (the hydrator assembles the entity from the id).

shipperTariffValuesToArray()  : array<string, mixed>

Converts a form container (`ArrayHash` from the multiplier) to a plain array so that typed offsets can be used. Anything other than an array or `ArrayHash` is an empty row.

showBranchModal()  : void

translateShipperTariff()  : string

validateShipperTariffBandCoverage()  : void

Validates band invariants within one generation: at most one open band, the open band must be the topmost, no overlaps (error) and ideally no gaps (warning only, a carrier may legitimately not ship every weight).