CoolCMS API

Checkout extends BaseComponent

in package

• Application

uses AddressFormTrait, RegionFormTrait, CheckoutRegionTrait, ShippingFormTrait, SummaryFormTrait, CheckoutErrorTrait

Renders the order steps.

Table of Contents

Constants

CHECKOUT_REGION_KEY  : string = 'paymentRegionId'

CHECKOUT_REGION_LOCALIZATION_KEY  : string = 'paymentRegionLocalizationId'

STEP_ADDRESS  : int = 1

STEP_SHIPPING  : int = 2

STEP_SUMMARY  : int = 3

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

$cart  : CartManager

$checkoutManager  : CheckoutManager

$checkoutRegionCache  : PaymentRegion|null

$checkoutRegionResolved  : bool

$countryManager  : CountryManager

$preview  : array<string, mixed>|null

Api preview, computed once per request (shared by render and handlers).

$step  : int

$userManager  : UserManager

Methods

__call()  : mixed

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

__construct()  : mixed

buildPayload()  : array<string, mixed>

Builds the Api payload: only identifiers and customer-entered texts, never a price, rate or discount.

createComponent()  : IComponent|null

getAppContext()  : AppContext

getCheckoutCurrency()  : Currency|null

Exposes the order currency for the cart and order presenter, which passes it as the page currency (`CurrencyContext::setPageCurrency()`) so that front end JS formats in the same currency.

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

getSelectedBranchId()  : int|null

getSelectedPaymentMethodId()  : int|null

getSelectedTariffId()  : int|null

Returns the selected tariff id, read from POST data first and from the session second.

getSettingContext()  : SettingContext

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

getStep()  : int

getThemeContext()  : ThemeContext|null

hasServiceByType()  : bool

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

hasUnpricedItems()  : bool

Returns whether the cart has a set without a price in the cart currency.

initializeAllContexts()  : void

injectDeviceDetector()  : void

invalidatePreview()  : void

Forces a new recalculation after an input change (AJAX auto-update of step 2).

isStepReachable()  : bool

A step is reachable only when all previous steps are filled in (guard in the presenter).

loadPreview()  : array<string, mixed>

Returns the order preview for the steps filled in so far.

onAddressSuccess()  : void

onCreate()  : void

onRegionSuccess()  : void

onShippingSubmit()  : void

Handles AJAX auto-update: stores the unfinished choice, drops the preview and redraws the snippet.

onShippingSuccess()  : void

onSummarySuccess()  : void

render()  : void

setAppContext()  : $this

setComponentParameter()  : void

Sets a component parameter.

setCurrencyContext()  : $this

setLanguageContext()  : $this

setLocalizationContext()  : $this

setSettingContext()  : $this

setStep()  : self

setThemeContext()  : $this

setup()  : void

setupAppContext()  : void

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

typedComponent()  : T

Returns a subcomponent with a verified type.

checkoutCurrency()  : Currency|null

Returns the cart or order currency, the currency of the region from {@see checkoutRegion()}.

checkoutRegion()  : PaymentRegion|null

Returns the region by which the cart and order are computed.

checkoutRegionName()  : string

Returns the region name in the website language (fallback `#id`).

checkoutRegionNotice()  : array{region: string, currency: string, currencyChanged: bool}|null

Returns the recalculation notice data; null when the cart computes in the localization region, otherwise the chosen region name and currency (the template builds a sentence from them).

createComponentAddressForm()  : Form

createComponentRegionForm()  : Form

createComponentShippingForm()  : Form

createComponentSummaryForm()  : Form

frontPresenter()  : BasePresenter|null

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

getTranslator()  : ITranslator

resetCheckoutRegion()  : void

Forgets the resolved region (after a new choice is stored within the same request).

setTemplateFile()  : void

setTranslator()  : self

applyUserAccountFallback()  : void

Prefills defaults for a logged-in customer: unfinished checkout first, then the account.

boolValue()  : bool

branchItems()  : array<int, string>

Returns branches (`shipper_tariff_branches`) of the selected tariff.

checkoutCurrencies()  : array<int, Currency>

checkoutCurrencyShortcut()  : string

checkoutErrorFlash()  : Message

Returns the same message for a flash; a flash is translated only in the layout, so it carries the key with parameters.

checkoutErrorText()  : string

Returns the translated text for direct output in the template (the preview error bar).

checkoutInt()  : int|null

Reads the value only from the unfinished checkout in the session (no POST); see {@see buildPayload()}.

controlString()  : string

countryOptions()  : array<string, string>

Returns country options for the select (active countries, CZ and SK first; {@see \App\Core\Utils\Helpers\CountryOptionsHelper}).

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

decodePickupPoint()  : array<string, mixed>|null

Decodes the raw JSON from the `pickupPoint` hidden field into an associative array.

goToStep()  : void

handlePlaceFailure()  : void

isPickupPointMissing()  : bool

Returns whether the selected tariff requires a pickup point that is missing in the unfinished checkout.

offeredId()  : int|null

Returns the id when it is among the items, otherwise null.

optionInt()  : int

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

Returns offer rows from the Api response.

optionStr()  : string

persistShippingSelection()  : void

pickupInfo()  : array{requiresPickup: bool, widget: array|null}|null

Returns the pickup point info of the selected tariff.

pickupPointJson()  : string

Encodes the point back for the hidden field `setDefaults()`; the exact opposite of {@see decodePickupPoint()}.

postOrCheckoutInt()  : int|null

redirectToDone()  : void

regionItems()  : array<int, string>

Returns usable regions (active, with an active non-internal currency) as "Name (currency)".

requestedCheckoutRegionId()  : int|null

setAddressDefaults()  : void

shippingOptions()  : array{shipping: list>, payment: list>}

stringKeyed()  : array<string, mixed>

Narrows `array<mixed, mixed>` to `array<string, mixed>`.

strValue()  : string

summaryStr()  : string

translatePrompt()  : string

Translates a text for a control with a disabled translator (the country select).