CoolCMS API

AbstractRuleEditor extends BaseComponent

in package

• Application

uses PrivilegeGuardTrait

Editor of a single option rule (`SHOW_SELECT_OPTIONS`, action = 1), rendered live as `{control ruleEditor-<id>}` into a modal outside `editForm`.

Table of Contents

Constants

DEFAULT_MODAL_ID  : mixed = 'rule-editor-modal'

Default DOM id of the shell (Options / option reveal).

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

$conditionOptionDefaults  : array<int, array<int, int>>

GET prefill of checked condition options for onAnchor, keyed by the condition row index.

$modalId  : string

DOM id of the modal shell; differs for Options and display rules (two shells, one active).

$parameterManager  : Manager

$parameterRuleManager  : AbstractParameterRuleManager

$pickerFactory  : PickerFactory

$ruleId  : int

Edited rule (0 = new); the Multiplier key.

$selectId  : int

SELECT (>0) is the "reveal options" mode (Options); 0 is the "conditions only" mode (display rules).

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

hasServiceByType()  : bool

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

initializeAllContexts()  : void

injectDeviceDetector()  : void

onCreate()  : void

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

createComponentEditorForm()  : Form

createComponentPicker()  : Multiplier<string|int, Picker>

frontPresenter()  : BasePresenter|null

Returns the front presenter the component is attached to (null outside the front end or when detached).

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

parameterTargetPresenter()  : string

Presenter targeted by the condition source picker (`:Admin:Bazaar:Parameter` / `:Admin:Comcat:Parameter`).

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

addConditionRow()  : void

Condition row: source (picker hidden), label, operator, and source options or a text value.

applyDefaults()  : void

GET prefill from the stored rule: conditions (through the manager, works for floating rules too) and reveal targets.

childOptionItems()  : array<int, NotTranslate>

Returns child parameters (options) of parameter `$parentId` as checkbox list items (id to name).

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

parsePickerName()  : array{0: string, 1: list}

pickers()  : array<string, PickerConfig>

Condition source picker: the field `conditions[<i>].parameterId` on `editorForm`.

refreshConditionOptions()  : void

onAnchor: renders the source child options into the `options` checkbox list of each condition.

resolveParameterLabel()  : string|null

suggestParameters()  : array<int, array{id: int, label: string}>

tr()  : string

Translates a key in the component domain to a final string.

validatorOptions()  : array<string, NotTranslate>

Returns operators (Nette validators) as a select option list; skips codes longer than the DB column (varchar 15).