CoolCMS API

ParameterPickerTrait

Advert parameter picker for a row of the "parameter settings" multiplier (targeting parameters at a category). Suggester by name (`translations.name`) plus a modal with the `show` grid `:Admin:Bazaar:Parameter` in picker mode. The hidden `parameterId` and the text `parameterName` live in the `parameterRels` container row (created by {@see \App\UI\Admin\Bazaar\Presenters\Traits\Forms\CategoryFormTrait}).

$this->parameterManager is shared with the form trait (loading the options = child parameters). See NewsletterAddressPickerTrait.

Table of Contents

Properties

$parameterManager  : ParameterManager

Methods

parameterPicker()  : PickerConfig
Config for {@see \App\UI\Admin\System\Presenters\Traits\Pickers\PickerHostTrait::pickers()}.
parameterDisplayName()  : string
Parameter name in the current language (falls back to the first non-empty one).
resolveParameterLabel()  : string|null
suggestParameters()  : array<int, array{id: int, label: string}>

Properties

Methods

parameterPicker()

Config for {@see \App\UI\Admin\System\Presenters\Traits\Pickers\PickerHostTrait::pickers()}.

protected parameterPicker([string $formName = 'editForm' ][, string $container = 'parameterGroups' ][, string $nestedContainer = 'parameters' ][, string $targetField = 'parameterId' ][, string $displayField = 'parameterName' ][, string $submitButton = 'parametersRefresh' ]) : PickerConfig

The picker sits in a nested multiplier (groups, then parameters), hence nestedContainer.

Parameters
$formName : string = 'editForm'
$container : string = 'parameterGroups'

outer multiplier (parameterGroups)

$nestedContainer : string = 'parameters'

nested parameters multiplier (parameters)

$targetField : string = 'parameterId'
$displayField : string = 'parameterName'
$submitButton : string = 'parametersRefresh'
Return values
PickerConfig

parameterDisplayName()

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

private parameterDisplayName(Parameter $parameter) : string
Parameters
$parameter : Parameter
Return values
string

resolveParameterLabel()

private resolveParameterLabel(int $id) : string|null
Parameters
$id : int
Return values
string|null

suggestParameters()

private suggestParameters(string $query) : array<int, array{id: int, label: string}>
Parameters
$query : string
Return values
array<int, array{id: int, label: string}>
On this page

Search results