CoolCMS API

AbstractOptionRules extends BaseComponent

in package

• Application

uses ModalAwareTrait, PrivilegeGuardTrait

Admin immediate-save management of option rules (`SHOW_SELECT_OPTIONS`, action = 1) of one SELECT.

Table of Contents

Properties

$container  : Container

$parameterId  : int

Select whose rules the component manages. Persistent, so it survives the `assignForm` submit.

$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

$assignOptionId  : int|null

Option whose rules are being edited in the modal (per-option axis); null when inactive.

$assignRuleId  : int|null

Rule whose target options are being edited in the modal (per-rule axis); null when inactive.

$bulkOptionIds  : array<int, int>

Options selected for bulk rule assignment (per-selection axis); empty when inactive.

$optionNameCache  : array<int, string>

Cache of option (child parameter) names by id for rule summaries within one render.

$parameterManager  : Manager

$parameterRuleManager  : AbstractParameterRuleManager

Methods

__call()  : mixed

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

__construct()  : mixed

createComponent()  : IComponent|null

createComponentAssignForm()  : Form

createComponentBulkAssignForm()  : Form

Bulk modal (per-selection): a checkbox list of rules (unified pool); a checked rule is added to every selected option. It is not prefilled (a "common state" makes no sense across a heterogeneous selection), it only adds. Selected options travel in the hidden `optionIds` (the state does not survive the submit); `parameterId` is persistent and rule items do not depend on it, they draw from the global pool.

createComponentOptionRulesForm()  : Form

Per-option modal: checkbox list of rules (action = 1 of the select), pre-checked = controlling this option.

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

handleAssignRules()  : void

Opens the modal editing rules that control the given option (per-option axis).

handleBulkAssignRules()  : void

Opens the modal for bulk assigning a rule to several selected options (per-selection axis).

handleDeleteRule()  : void

Deletes the rule (DB FK cascade removes conditions, values and targets) and recomputes `always_visible`.

handleEditTargets()  : void

Opens the modal editing target options of a rule (per-rule axis).

hasServiceByType()  : bool

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

initializeAllContexts()  : void

injectDeviceDetector()  : void

onAssignFormError()  : void

onAssignFormSuccess()  : void

onBulkAssignFormError()  : void

onBulkAssignFormSuccess()  : void

onCreate()  : void

onOptionRulesFormError()  : void

onOptionRulesFormSuccess()  : 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).

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.

operatorsDomain()  : string

Domain of operator texts (`admin.bazaar.operators` / `admin.comcat.operators`).

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

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

displayName()  : string

Parameter name in the current language (falls back to the first non-empty one), like `parameterDisplayName`.

loadRules()  : array<int, array{ruleId: int, summary: string, targetOptionIds: list, targetNames: list, targetCount: int}>

Returns stored SHOW_SELECT_OPTIONS rules targeting this select as display rows (condition summary plus target options).

operatorLabel()  : string

Returns the operator (validator) label for the rule summary.

optionItems()  : array<int, string>

Returns the options (child parameters) of this select as checkbox list items (id to name).

optionName()  : string

Option name for the per-option modal header.

optionNameById()  : string

Returns the option (child parameter) name by id; falls back from {@see ruleSummary()} when the hydrator does not load the 3-level relation `conditionsCollection.valuesCollection.option` (the relation stays null while the mirror column `option_id` is filled). The condition source is another parameter than this select, so {@see optionItems()} does not know its options and the name is resolved through the ParameterManager. Lazily cached across all rules of one render.

parseOptionIds()  : array<int, int>

Parses a CSV ("2,5,7") from the client into a list of positive option ids (deduplicated, order kept).

renderModalContent()  : string

Renders the modal content into a string for ModalWindow.

requireHostEditPrivilege()  : void

IMPORTANT: server-side gate for every signal and submit of the component: the host `edit` privilege of the hosting presenter (`:Admin:<Module>:Parameter:edit`). The component can be invoked on every host action (even `show`), so the gate of the `edit` action does not cover it, and hiding the buttons is no protection. Rules are a global pool on purpose, so there is no `ruleId` binding to the target, only the privilege. Call it as the first statement.

ruleItems()  : array<int, string>

Returns checkbox list items of the per-option modal: the unified pool (every rule; the effect derives from the target). Checking a rule assigns it to the option (it gets an option target and exposes the option), so a rule created elsewhere (e.g. in display rules) can be reused. Maps ruleId to summary.

ruleSummary()  : string

Summarizes the rule conditions for the list and modal: "<source> <operator> <values>" joined by " + ".

ruleSummaryById()  : string

Summarizes the rule by id (for the modal header).

showModal()  : void

Fills the shared admin ModalWindow with the current state and opens it.

tr()  : string

Translates a key in the component domain to a final string (also for fields with `setTranslator(null)`).