CoolCMS API

AdvertFilterBox extends ParameterForm

in package

• Application

uses LoadingTrait, RegionSuggestHostTrait

Abstract component for a modular form built from parameters.

Table of Contents

Constants

REGION_PREVIEW_KEYS  : array<string|int, mixed> = ['city', 'zip', 'country']

Parameters that the preview prefills after a selection (parameter key = item data key).

Properties

$categoryId  : int|null

$container  : Container

$onError  : array<string|int, callable(Form, static): void>

Signature: function(Form $form, self $component): void

$onSuccess  : array<string|int, callable(Form, ArrayHash, static): void>

$onValidate  : array<string|int, callable(Form, ArrayHash, static): void>

Events for the consumer (presenter / parent control). `ParameterForm` only renders and validates; business logic (save, email, redirect) belongs to whoever instantiates the component.

$routerDispatcher  : RouterDispatcher

$translator  : ITranslator

$appContext  : AppContext

$componentParameters  : array<string, mixed>

$context  : ParameterFormContext

$currencyContext  : CurrencyContext|null

$deviceDetector  : DeviceDetector|null

$itemsByGroups  : array<int, array<int, ParameterFormItem>>

$languageContext  : LanguageContext|null

$localizationContext  : LocalizationContext|null

$parameterAndOptionList  : array<int, ParameterInterface>

$parameterGroupList  : array<int, ParameterGroupInterface>

$parameterItems  : array<int, ParameterFormItem>

$registry  : ParameterHandlerRegistry

$settingContext  : SettingContext

$themeContext  : ThemeContext|null

$translatorDomain  : string|null

Translation domain is set by the module subclass (`AdvertForm`, `AdvertFilterBox`, ...).

$categoryManager  : CategoryManager

$categoryParameterRelManager  : CategoryParameterRelManager

$fieldBuilder  : ParameterFieldBuilder|null

$parameterGroupManager  : ParameterGroupManager

$parameterManager  : ParameterManager

$parametersInitialized  : bool

$regionManager  : RegionManager

$regionSuggestFactory  : RegionSuggestFactory

Methods

__call()  : mixed

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

__construct()  : mixed

createComponent()  : IComponent|null

getActiveFilters()  : array<int, array{parameterId: int, parameter: string, label: string, remove: array|null}>

Returns active filters for the badges above the list (`.pactive`), one entry per cancelable value, so "Sony" and "Canon" are two badges, not one.

getAppContext()  : AppContext

getComponentParameter()  : mixed

Returns a component parameter, or null when it is not set.

getContainer()  : Container

getCurrencyContext()  : CurrencyContext|null

getGroupChosenCount()  : int

Returns how many options of a group are selected, shown as a badge on the collapsible heading (`.filter-box__chosen`) so a collapsed group still shows that it filters.

getLanguageContext()  : LanguageContext|null

getLocalizationContext()  : LocalizationContext|null

getRouterDispatcher()  : RouterDispatcher

getSettingContext()  : SettingContext

getSettings()  : array<int, array<string, mixed>>

getThemeContext()  : ThemeContext|null

getUploaderControlMap()  : array<string, string>

Map of form control name to uploader child name. Latte looks it up while iterating `$group->getControls()`; when an entry exists for an input, it renders the dropzone plus the classic input with a toggle.

getUploaderParameterIds()  : array<string|int, int>

Ids of parameters that have a dropzone uploader. A child may override it for different behavior (for example no uploaders: an empty array).

hasServiceByType()  : bool

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

initializeAllContexts()  : void

injectDeviceDetector()  : void

onCreate()  : void

render()  : void

renderActiveFilters()  : void

Renders badges of active filters above the list, not inside the filter: otherwise canceling a filter would be reachable only by scrolling back up.

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

uploaderName()  : string

Name of the child uploader component for an upload parameter.

beforeRender()  : void

Hook: a child component may add its own template variables (for example the edited entity).

beforeSubmitButton()  : void

Hook: a child component may add its own fields before submit (recaptcha, password input, agreement checkbox and similar).

buildContext()  : void

buildRegistry()  : ParameterHandlerRegistry

Default registry covering all `ParameterType` constants. A child component may override it to add its own handlers (for example module-specific types).

createComponentForm()  : Form

createComponentRegionSuggest()  : Multiplier<string|int, RegionSuggest>

extractParameterValues()  : array<int, array<int, array{value: mixed, value2?: ?string}>>

Helper that extracts form values. Returns only persistable parameters, i.e. not file/image types.

findParameterByKey()  : ParameterInterface|null

frontPresenter()  : BasePresenter|null

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

getCurrentCategory()  : Category|null

getEntityValues()  : array<int, mixed>

Hook: map of entity values for prefill (parameterId => value | value[]).

getFieldBuilder()  : ParameterFieldBuilder

Lazy shared builder of parameter fields, initialized from the resolved engine state (items/groups/context/mode). Entity values are read at the first build (after `setAdvert()`/`setCategoryList()`), as with {@see \App\Core\Form\Parameters\Building\DefaultsTrait::applyDefaults()}.

getMode()  : string

Hook: mode that selects `getType` or `getSearchType` on a parameter.

getParameterTranslation()  : ParameterTextInterface|null

getSubmitLabel()  : string

getTranslator()  : ITranslator

hasResolvedType()  : bool

For a child component: tells whether the form contains a parameter of the given type (respecting the mode via `resolveType()`).

initParameters()  : void

isUploadParameter()  : bool

A classic `IMAGE` / `FILE` parameter has its own `<input type="file">` (via the handler); the dropzone uploader handles only the multi-upload `*_UPLOADER` variants.

loadParameterGroups()  : array<string|int, mixed>

loadParameters()  : array<string|int, ParameterFormItem>

parameterKey()  : string

Form control key of a parameter (`parameter_<id>`). Field building is done by the shared {@see \App\Core\Form\Parameters\ParameterFieldBuilder}, but the engine and its consumers (filter URL params, email/region denormalization) need the same key to look up submitted values.

processSubmit()  : void

resolveDefaultValue()  : string|null

resolveType()  : int|null

setTemplateFile()  : void

setTranslator()  : self

usesDefaultParameters()  : bool

Hook: when a child component returns true, only parameters with `getDefault()` = true (classic) or `getSearchDefault()` = true (search) are shown.

addFulltextField()  : void

Fulltext field `search` above the whole filter.

aggregateCategoryParameterRels()  : array<int, array{order: int, groupId: ?int}>

The filter has a single category (from the presenter), but the interface stays similar to `AdvertForm::aggregateCategoryParameterRels()`; if the filter ever handles several categories (multi-category list), the aggregation rules are already here: - useInSearch: a parameter is skipped when all rels have it false - order: min, groupId: first wins

applyUrlDefaults()  : void

buildParameterAndOptionList()  : void

Returns ids of the parameters that this parameterId uses (directly or through options), for lookup from rules. Options have no per-category override, so they are read straight from the Parameter entity.

buildRegionPreviewFieldMap()  : array<string, string>

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

indexById()  : array<int, T>

indexItemsByGroups()  : void

indexItemsById()  : array<int, ParameterFormItem>

initRegionPickerContext()  : void

Selection validator for {@see ParameterFormContext::$regionValidator}: the advert form accepts only an active municipality (tree leaf), so an old advert filed under a country forces choosing a municipality on edit.