CoolCMS API

CartWidget extends BaseComponent

in package

• Application

uses CartPreviewTrait, InitTrait, MiniCartTrait

Renders the header cart: a count badge plus a dropdown mini cart.

Table of Contents

Constants

COUNT_DISPLAY_MAX  : int = 99

Highest quantity the badge prints as a number; above it the badge shows "99+".

SETTINGS_MODULE_ESHOP  : int = 4

Settings module id of the eshop.

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

$detailLoaded  : bool

Whether the panel content was loaded by `loadDetail!` ({@see MiniCartTrait}); until then a loading state is rendered.

$preview  : array<string, mixed>|null

Api preview, filled by `render()` and shared by submit handlers for messages.

$productSetManager  : ProductSetManager

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

handleDecrease()  : void

handleIncrease()  : void

handleLoadDetail()  : void

First panel open; the only request allowed to trigger the Api cart recalculation.

handleRemove()  : void

hasServiceByType()  : bool

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

initializeAllContexts()  : void

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

typedComponent()  : T

Returns a subcomponent with a verified type.

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

allowsOutOfStockOrder()  : bool

Returns whether goods that are not in stock may be ordered (`order.outOfStock.allowed`); the same gate as in the catalog ({@see \App\UI\Front\Eshop\Presenters\Traits\Inits\CatalogOnlyGuardTrait::allowsOutOfStockOrder()}).

blockedSetIds()  : array<int, int>

Returns the set ids that block the continue-to-order button: rows the stock does not cover in the requested quantity (or that cannot be ordered at all) and sets without a price in the cart currency, which only the server preview knows (otherwise they would reach checkout and fail with a generic error). The server strict reservation on submit remains the last authority.

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

Merges session rows (setId and quantity) with preview data (name, price, uncovered stock) and catalog availability.

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

guardEnabled()  : void

A disabled eshop (`catalog.only = 1`) has no cart or panel; the same gate as `addToCart!`.

hasUnavailableRow()  : bool

Returns whether anything in the cart blocks submitting the order.

int()  : int

isCatalogOnly()  : bool

loadPreview()  : array<string, mixed>

Returns the Api preview, computed once per request and shared by `render()` and handlers (otherwise the same recalculation would run twice).

num()  : numeric-string

openDetail()  : void

Keeps the panel open and redrawn after each change.

prepareDetail()  : void

Called only with the panel open; the only place where the widget touches the Api.

prepareWidget()  : bool

rowFees()  : array<int, array{name: string, price: numeric-string}>

Returns informational row fees in the display price column (see `buildRows()`).

str()  : string

DBAL/Api scalar (mixed) → string, guarded.

unpricedItems()  : array<int, string>

Returns sets the Api omitted from the preview because they have no price in the cart currency.

vatNoteMode()  : bool|null

Returns the VAT note variant for cart templates: `null` means the order charges no VAT and VAT is not mentioned; `true` means prices are shown with VAT. The Api sends `showPricesWithVat` equal to `withVat` (the VAT engine treatment; the seller switch `show_prices_with_vat` is no longer read), so `false` does not occur today. A preview without an Api response gives `null`, because silence is safer than a false claim.