CoolCMS API

BookingCalendar extends BaseComponent

in package

• Application

uses InitTrait, SignalTrait, FormTrait, CancelTrait

Two-step booking calendar of the "time slots" 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.

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

`MM` mapped to a short key under `calendar.months.*` (own keys; there is no system month localization).

Properties

$container  : Container

$day  : string|null

Chosen day `YYYY-MM-DD` of step 2; `null` means only the month grid.

$month  : string

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

$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

$availabilityCache  : array<string, mixed>|null

Memoizes {@see TimeSlotManager::availability()} within one request (see `InitTrait::fetchAvailability()`).

$cancelToken  : string|null

Token from `?cancel=<token>`, set by the presenter; `null` means the normal calendar.

$reservationManager  : ReservationManager

$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

handleBackToMonth()  : void

handleChangeMonth()  : void

handleSelectDay()  : void

hasServiceByType()  : bool

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

initializeAllContexts()  : void

injectDeviceDetector()  : void

onBookingFormSuccess()  : void

onCancelFormSuccess()  : void

onCreate()  : void

render()  : void

setAppContext()  : $this

setCancelToken()  : self

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

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

buildEndOptions()  : array<string, string>

Returns the end offer: the union of reachable ends over all starts, in steps of `slotLengthMinutes`, capped by `maxTo` of the given start. The server validates the concrete `(from, to)` pair again in `book()`; this offer only limits choices to sensible values and is not an authoritative check.

buildStartOptions()  : array<string, string>

Returns the start offer from `starts` (the offer step, not the grid).

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

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

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

currentMonth()  : string

fetchAvailability()  : array<string, mixed>

Returns `TimeSlotManager::availability()` for `$this->month`, memoized for the lifetime of this component instance (one request). Required because the step 2 form can be created before `render()` (a form POST calls `createComponent*()` first, and `render()` would not run at all on a redirect or an error), so `prepareCalendar()` alone cannot be relied on.

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

Returns the data of the chosen day (`starts`/`free`/`busy`/...), or `null` when no day is chosen or it does not exist.

finishBookingForm()  : void

formatMinutes()  : string

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

prefillIdentity()  : void

prepareCalendar()  : void

prepareCancelForm()  : void

resolveDay()  : string|null

Accepts the chosen day only when it belongs to the displayed month and exists in the Api response; otherwise a day from another month would stay in the URL after switching months.

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