CoolCMS API

BookingWizard extends BaseComponent

in package

• Application

uses InitTrait, SignalTrait, ModalTrait, FormTrait

Booking wizard: the successor of {@see \App\UI\Front\Company\Components\BookingCalendarComponent\BookingCalendar} on the new "book a time slot" page.

Table of Contents

Constants

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

`ResultCode->value` (Api) mapped to the translated message key; an unknown code gives the generic message.

MODAL_TARGET  : string = 'companyBookingWizardModal'

The only target of the wizard modal; the calendar and the form share the same window.

MONTH_KEYS  : array<string|int, mixed> = ['01' => 'jan', '02' => 'feb', '03' => 'mar', '...

`MM` mapped to a short key under `calendar.months.*` (shared with the old component, see `front.*.neon`).

WEEKDAY_KEYS  : array<string|int, mixed> = [1 => 'mon', 2 => 'tue', 3 => 'wed', 4 => 'thu'...

ISO day number (`N`) mapped to a short key under `calendar.weekdays*.*`.

Properties

$calendarId  : int

Chosen public calendar; `0` means the first public calendar of the company (see `resolveCalendarId()`).

$container  : Container

$day  : string|null

Chosen day `YYYY-MM-DD`; `null` means the "month" state (grid).

$inModal  : bool

Render mode: `false` = inline (the wizard is directly in the page), `true` = modal (the wizard lives in a modal window). Persistent so links inside the modal carry it; `render()` takes no arguments.

$month  : string

Displayed month `YYYY-MM`; empty means the server's current month (see `resolveMonth()`).

$routerDispatcher  : RouterDispatcher

$slotFrom  : string|null

Start `HH:MM` of the tapped slot; `null` means no slot chosen. Persistent because the booking form in the modal is submitted by another request and must know which block it came from (the server verifies the pair against `dayStarts` anyway; the client is not trusted).

$slotTo  : string|null

End `HH:MM` of the tapped slot; prefills `timeTo` (the `maxTo` cap is handled by `FormTrait`).

$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

$availabilityCache  : array<string, array<string, mixed>>

Memoizes {@see TimeSlotManager::availability()} within one request, keyed by `month|calendar`; the component asks at most twice per request (the default calendar for the list of public calendars plus the chosen calendar).

$bookingMessage  : string|null

Message printed inside the modal (not through the session flash, which would duplicate the inline output on the page).

$bookingMessageType  : string

$dayStarts  : array<int, array{from: string, to: string, maxTo: string}>

Offered starts of the chosen day after the server-side lead-time trim. Computed by `InitTrait::prepareWizard()` and read by the slot-choice signal too, to verify the `(from, to)` pair sent by the client against server data, not against the template.

$eventDispatcher  : EventDispatcher

$modalRegistry  : ModalRegistry

$reservationManager  : ReservationManager

$slotLengthMinutes  : int

Slot length of the chosen calendar in minutes; the step of the end offer in the booking form.

$timeSlotManager  : TimeSlotManager

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

handleBackToCalendar()  : void

Back arrow from the booking form to the calendar (modal mode only).

handleBackToMonth()  : void

handleChangeMonth()  : void

handleSelectCalendar()  : void

handleSelectDay()  : void

handleSelectSlot()  : void

Handles a click on a slot block: opens the booking modal with the recap and the form.

handleShowCalendarModal()  : void

Handles the "book a time slot" button on the "my time slots" page: opens the wizard (month grid) in a modal window. From now on the component is in modal mode and all its links carry it in the persistent `inModal`.

hasServiceByType()  : bool

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

initializeAllContexts()  : void

injectDeviceDetector()  : void

onBookingFormError()  : void

Validation errors (missing consent, empty name...); the modal stays open with the form.

onBookingFormSuccess()  : void

onCreate()  : void

render()  : void

IMPORTANT: takes no arguments. The context (mode, calendar) belongs in persistent parameters and signals, otherwise an AJAX redraw of the snippet would render nothing.

renderButton()  : void

Second render mode: on the "my time slots" page the component renders only the "book a time slot" button; the whole wizard opens in a modal ({@see ModalTrait::handleShowCalendarModal()}).

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.

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

bookableStarts()  : array<int, array{from: string, to: string, maxTo: string}>

Returns the offered day starts after the lead-time trim. The Api already trims them (free time is cut from the left by `now + leadTimeHours`), but the front end does not rely on it: time can pass between computing and rendering (cache, long request) and offering a slot the lead time no longer allows would mean a click into an error.

buildEndOptions()  : array<string, string>

Returns the ends: the union of reachable ends over all starts of the day, in steps of `slotLengthMinutes`, capped by `maxTo`. Not authoritative; the server verifies the pair again.

buildStartOptions()  : array<string, string>

Returns the starts: the server-trimmed `starts` of the chosen day ({@see InitTrait::bookableStarts()}).

buildWeeks()  : array<int, array<int, array{date: string, dayNumber: int, weekdayKey: string, state: string, freeMinutesLabel: string|null, isPast: bool, isToday: bool, bookable: bool, startCount: int}|null>>

Builds the month grid by weeks (Monday first); a `null` cell is padding outside the month and is never clickable.

createFormContent()  : string

Second view: recap + booking form.

createModalEvent()  : ModalWindowEvent

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.

createResultContent()  : string

Second view after submit: the result message instead of the form (the form is no longer offered).

createStandardComponent()  : IComponent|null

Creates a standard component (not a multiplier).

createWizardContent()  : string

First view: the same wizard (header + month/day) as in inline mode, rendered into a string.

currentMonth()  : string

fetchAvailability()  : array<string, mixed>

Returns {@see \App\UI\Front\Company\Models\Managers\TimeSlotManager::availability()} memoized for the lifetime of this component instance (one request), keyed by month and calendar.

findCalendar()  : array{id: int, name: string, description: string|null}|null

finishBooking()  : void

Success (also the silent honeypot one); the message stays in the modal and the calendar below is redrawn.

formatDayHeading()  : string

Formats `YYYY-MM-DD` as e.g. "Thursday, September 10, 2026" by the `day.heading` pattern of the language.

formatMinutes()  : string

Minutes since midnight to `H:MM` (same as the Api `TimeSlotManager::formatMinutes()`, without a cross-module import).

formatTime()  : string

Minutes since midnight to `HH:MM` (the end offer must match `starts` in shape, i.e. with a leading zero).

isDayBookable()  : bool

Applies the day clickability rules: past days are not bookable, `closed` or without starts are not, today only when at least one start remains after the `leadTimeHours` trim. Padding is handled by the template (a `null` cell) and never gets here.

openOrUpdateModal()  : void

Opens the modal or, when it already exists in the registry, only replaces its content.

prefillIdentity()  : void

prepareFormTemplate()  : void

Recap data and messages for `Sections/Form.latte`.

prepareWizard()  : void

refreshWizardAfterBooking()  : void

Second snippet next to the modal: in inline mode the redrawn calendar on the booking page, in modal mode the client's reservation list on the "my time slots" page (a new one was added).

refreshWizardView()  : void

Redraws the wizard after a navigation signal: in inline mode through the `wizard` snippet, in modal mode by replacing the modal content.

renderPartial()  : string

Renders a partial into a string (like `WatchdogFormComponent\Traits\ModalTrait`).

resolveCalendarId()  : int

Resolves the calendar id. IMPORTANT: the persistent `calendarId` from the URL is not trusted; only values from the list of public calendars of the presented company are valid. A foreign, non-public or nonsensical id falls back to the first public calendar (and `0` when the company has none).

resolveDay()  : string|null

Accepts the chosen day only when it belongs to the displayed month, exists in the Api response and is bookable; otherwise the wizard returns to the "month" state. Without this check a hand-edited URL could open the slot list of a past or closed day.

resolveErrorMessageKey()  : string

An unknown or missing code gives the generic message.

resolveMonth()  : string

`YYYY-MM`; empty, invalid or past input falls back to the server's current month.

shiftMonth()  : string

str()  : string

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

toMinutes()  : int