Skip to main content
Version: v0.2 (next)

Built-in Filter Elements

All classes live in HeimrichHannot\FlareBundle\Filter\Element\ unless noted otherwise and are named after their type with a FilterElement suffix (e.g. flare_boolBooleanFilterElement). "Form controls" are the Symfony form fields the element builds in the frontend filter form; elements without any are applied without a user-facing form field (typically as intrinsic filters).

TypeBackend labelForm controlsPurpose
flare_archiveArchiveChoiceTypeFilter by parent archive (e.g. news archives).
flare_boolBoolean property valueCheckboxTypeFilter on a boolean column.
flare_calendar_currentCalendar time windowDateType (from/to)Time-window filter for calendar events, recurring-aware.
flare_dateRangeDate rangeDateType (from/to)Filter a date column by from/to values; either field can be disabled via the from_enabled/to_enabled config options.
flare_dcaSelectFieldDCA field options selectionChoiceTypeChoices from a DCA select field's options.
flare_equation_simpleSimple equationIntrinsic column <operator> value condition.
flare_fieldValueChoiceDCA field value selection (beta)ChoiceTypeChoices from the distinct values of a column.
flare_publishedPublishedContao publish state incl. start/stop dates.
flare_relation_belongsToRelation: Belongs toFilter by a belongs-to (pid) relation, dynamic-ptable-aware.
flare_search_keywordsKeyword searchTextTypeKeyword search across configured columns.

Each element translates its configuration into calls to reusable filter types, which build the actual query fragments.

Integration filter elements

Available when codefog/tags-bundle is installed (classes in HeimrichHannot\FlareBundle\Integration\CodefogTags\FilterElement\):

TypeBackend labelForm controlsPurpose
cfg_tags_choiceTags [codefog/tags-bundle]ChoiceTypeFilter by tags of the source field.
cfg_tags_searchKeyword search across tag names — currently disabled (under development, hidden from the backend selection).

To create your own filter element, see Developers / Custom Filter Elements.