CoolCMS API

SlotModal extends BaseComponent

in package

• Application

uses ModalAwareTrait, PrivilegeGuardTrait

Time slot edit modal of the admin calendar.

Table of Contents

Constants

FILL_ACTION_BLOCK  : string = 'block'

`fillAction` switch (mode A): `TimeSlotManager::save()` with `type=blocked`.

FILL_ACTION_OPEN_WINDOW  : string = 'openWindow'

`fillAction` switch (mode A): {@see TimeSlotManager::openWindow()}, creating a time slot on closed time.

FILL_ACTION_RESERVE  : string = 'reserve'

`fillAction` switch (mode A): {@see ReservationManager::bookByAdmin()}.

MODE_BLOCKED  : string = 'blocked'

Click on a `blocked` block: an admin block without a client.

MODE_FILL  : string = 'fill'

Click on a `free` block: a new reservation or block.

MODE_RESERVATION  : string = 'reservation'

Click on a `confirmed`/`pending` block: an existing reservation.

SNIPPET_DAY  : string = 'dayTimeline'

Day timeline snippet (`day.latte`); the default redraw target.

SNIPPET_WEEK  : string = 'weekGrid'

Week grid snippet (`week.latte`).

TIME_ACTION_KEEP  : string = 'keep'

`timeAction` switch (mode B): keeps the range and calls only `updateByAdmin()`.

TIME_ACTION_SHORTEN  : string = 'shorten'

`timeAction` switch (mode B): additionally calls {@see TimeSlotManager::shorten()}.

TIME_ACTION_SPLIT  : string = 'split'

`timeAction` switch (mode B): additionally calls {@see TimeSlotManager::split()}.

EDIT_PRIVILEGE  : string = ':Admin:Company:TimeSlot:edit'

Same key as `SchedulePresenter::handleMergeSlots()` and `TimeSlotPresenter::actionEdit()`.

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

$allCalendars  : bool

Week view of all calendars; must survive the redraw.

$calendarId  : int

$calendarManager  : CalendarManager

$companyId  : int

Company the view is rendered for; context for redrawing the timeline only.

$date  : string

`Y-m-d` of the day whose timeline or grid the modal serves.

$done  : bool

The action finished and nothing is left to offer (canceled reservation or deleted block).

$fromMin  : int

Range of the clicked free block in minutes after midnight ({@see MODE_FILL} only).

$mode  : string

Active mode; `''` means the modal does not open in this request.

$notice  : array{type: string, text: string}|null

Per-request message rendered inside the modal (pitfall 4 in the class docblock).

$reservation  : Reservation|null

Active reservation on {@see $slot} ({@see MODE_RESERVATION}).

$reservationManager  : ReservationManager

$returnSnippet  : string

Snippet to redraw after an action: `dayTimeline` or `weekGrid`.

$slot  : TimeSlot|null

Calendar row ({@see MODE_RESERVATION}/{@see MODE_BLOCKED} modes).

$timeSlotManager  : TimeSlotManager

$toMin  : int

Methods

__call()  : mixed

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

__construct()  : mixed

createComponent()  : IComponent|null

createComponentSlotForm()  : Form

Builds one form whose fields depend on the mode (pitfalls 2 and 3 in the class docblock).

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

getViewContext()  : array{companyId: int, calendarId: int, date: string, allCalendars: bool}|null

Returns the view context after the signal was handled.

handleOpenBlocked()  : void

Click on a block of a time block ({@see MODE_BLOCKED} mode).

handleOpenFree()  : void

Click on a free block of the day timeline ({@see MODE_FILL} mode).

handleOpenReservation()  : void

Click on a block with an active reservation ({@see MODE_RESERVATION} mode).

hasServiceByType()  : bool

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

initializeAllContexts()  : void

injectDeviceDetector()  : void

onCancelReservation()  : void

Mode B, cancel reservation: reuses {@see ReservationManager::cancel()}.

onCreate()  : void

onDeleteBlock()  : void

Mode C, cancel block: reuses {@see TimeSlotManager::delete()}.

onFillSave()  : void

Mode A, single button: calls {@see ReservationManager::bookByAdmin()} or `TimeSlotManager::save()` with `type=blocked`, chosen by the submitted value of the `blocked` switch, not by which button caught the click.

onReservationSave()  : void

Mode B, single save button: always calls {@see ReservationManager::updateByAdmin()} (name, e-mail, phone, note, state; never the time), and additionally acts on the submitted value of the `timeAction` switch: `keep` does nothing more, `shorten`/`split` also call {@see TimeSlotManager::shorten()}/`::split()`.

render()  : void

Renders nothing into the page; it exists for its signals and to fill the shared {@see \App\UI\Admin\System\Components\ModalWindowComponent\ModalWindow} from `@layout.latte`.

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

getModalWindow()  : ModalWindow

getTranslator()  : ITranslator

isTargetAllowed()  : bool

Returns whether the logged-in user may open the given admin target. For visibility (tiles, autocomplete, buttons); it does not throw.

requirePrivilege()  : void

Throws 403 when the logged-in user lacks the given admin privilege.

resolvePageTarget()  : string|null

Returns the RBAC key of the target page: `<presenter>:<action>`, e.g. `:Admin:System:User:show`.

setTemplateFile()  : void

setTranslator()  : self

addBlockedFields()  : void

Mode C: a block with no editable fields; the only action is canceling it.

addFillFields()  : void

Mode A: a new reservation on a free interval, or a block of the same range.

addReservationFields()  : void

Mode B: an existing reservation with details and state, shorten/split tools and cancellation.

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

failAndReopen()  : void

Turns an Api action failure into a readable message inside the modal (no flash, pitfall 4).

fillActionOptions()  : array<string, string>

Returns the `fillAction` options as translation keys, like {@see timeActionOptions()} (`addRadioList()` translates them through the form `useDomainTranslator()`).

findCalendar()  : Calendar|null

findSlot()  : TimeSlot|null

finish()  : void

Refills the modal and redraws the underlying timeline or grid (pitfall 5 in the class docblock).

formatDate()  : string

Converts `Y-m-d` to `j. n. Y`; an invalid date is returned unchanged.

formatMinutes()  : string

Converts minutes after midnight to `HH:MM`, like Api `TimeSlotManager::formatMinutes()`.

hydrateContext()  : void

Restores the view context from the submitted hidden fields, because the signal link of the form does not carry it (pitfall 1 in the class docblock). Calendar and day of modes B and C are loaded from the time slot, not from here.

int()  : int

loadReservationContext()  : void

Loads a fresh row and its active reservation (pitfall 6 in the class docblock: hydrated objects do not update after a bridge write).

normalizeSnippet()  : string

Allows only the two known values; a foreign string would crash the request in `redrawControl()`.

noticeError()  : void

noticeSuccess()  : void

parseTime()  : DateTime|null

Converts the value of `<input type=time>` to `DateTime`, or null when empty or invalid.

renderModalContent()  : string

Renders the modal content to a string for `ModalWindow`.

requireCalendarInCompany()  : void

403 when an existing calendar does not belong to the company the modal was opened from.

requireReservationOfSlot()  : void

403 when the posted reservation id points to a reservation of a different slot.

requireSlotInCompany()  : void

403 when an existing slot does not belong to the company the modal was opened from.

resolveMode()  : string

Returns the mode used to build the form.

saveBlock()  : Result

Saves a block through `save()` with an entity of `type = blocked` (no dedicated Api action; the same path as `TimeSlotFormTrait`).

saveReservation()  : Result

saveWindow()  : Result

Creates a time slot through {@see TimeSlotManager::openWindow()}.

showModal()  : void

Fills and opens the shared admin modal with the current state.

stateOptions()  : array<string, string>

str()  : string

strOrNull()  : string|null

text()  : string

Returns final translated text (not a key) for the {@see $notice} buffer and select options.

timeActionOptions()  : array<string, string>

Returns the `timeAction` options as translation keys.

values()  : array<string, mixed>

Returns the form values.