CoolCMS API

Picker extends BaseComponent

in package

• Application

uses PrivilegeGuardTrait

Selects a related object into a form; replaces a long `<select>`.

Tags

see

DataGrid::setPickerMode()

Table of Contents

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

$config  : PickerConfig

$rowIndices  : array<int, string>

Row indices of the container path, outside in (`addresses[2]` -> `['2']`; nested `parameterGroups[1].parameters[0]` -> `['1','0']`). Empty means a top-level field.

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

handleCreate()  : void

Creates a new record straight from the suggester: the user types a text that is not in the code list, clicks "Add ..." and the picker selects the new record at once.

handleSuggest()  : void

Suggester (AJAX): returns JSON with a list of items. Calls the callback from the configuration, so the picker knows neither the manager nor the filters.

hasServiceByType()  : bool

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

initializeAllContexts()  : void

injectDeviceDetector()  : void

onCreate()  : void

render()  : void

setAppContext()  : $this

setComponentParameter()  : void

Sets a component parameter.

setConfig()  : self

setCurrencyContext()  : $this

setLanguageContext()  : $this

setLocalizationContext()  : $this

setRowIndex()  : self

Sets the multiplier row index (one level); backward-compatible wrapper over {@see setRowIndices()}.

setRowIndices()  : self

Sets the row indices for (possibly nested) multipliers, outside in.

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

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

containerPath()  : array<int, string>

Returns the container path, outside in (`['parameterGroups','parameters']`); empty means top-level.

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

findControl()  : BaseControl|null

requirePresenter()  : Presenter

resolveControls()  : BaseControl}

Finds the form controls the picker belongs to: the hidden one with the id (required) and an optional text display control. Works for a top-level field and for a field inside a multiplier row (`$form[targetContainer][rowIndex][targetField]`).

resolveFieldMap()  : array<string, string>

Finds the htmlId of the target control for each mapped field ({@see PickerConfig::getFieldMap()}); JS then fills these fields too after selecting.

resolveForm()  : Form|null

Finds the target form ({@see PickerConfig::getFormName()}) by walking the component tree upward from the picker. Works whether the picker is hosted on a presenter (the form is a direct child of the presenter, classic admin forms) or inside a component (the form is a child of the hosting component, e.g. the parameter form engine, where the component creates the form itself).

resolveParent()  : Container|null

Returns the container with the picker fields: the form (top-level), a multiplier row, or a nested multiplier row. Walks the container path outside in and descends into the row by the matching index from {@see $rowIndices} on each level.