Built-in Predicates

Predicates (formerly called "filter types") are reusable query-fragment builders in the namespace HeimrichHannot\FlareBundle\Filter\Predicate\. They are consumed by filter elements (via FilterContextBuilderInterface::addPredicate()) — including inline filters added programmatically — see the predicates guide.

Options are validated against each predicate's configureOptions() schema. Required options have no default.

Class	Options	Purpose
ArchivePredicate	field (string, default pid), parent_ids (array, required)	Constrains records to a set of parent/archive IDs.
BelongsToRelationPredicate	field_pid (string, required), field_dynamic_ptable (?string, default null), whitelist (array, default []), parent_groups (array, default []), submitted_data (?array, default null)	Filters by a belongs-to (parent) relation, optionally with a dynamic ptable.
BooleanPredicate	field (string, required), value (bool, required)	Matches a boolean/checkbox column against an expected value.
CalendarCurrentPredicate	start (int, required), stop (int, required), has_extended_events (bool, default false)	Constrains calendar events to a time window.
DateRangePredicate	field (string, required), from (?\DateTimeInterface, default null), to (?\DateTimeInterface, default null)	Matches a timestamp column against a date range.
DcaSelectPredicate	field (string, required), selected (array, required), valid_options (array, required), is_serialized (bool, default false)	Matches a DCA select field against chosen options, incl. serialized multi-value fields.
FieldValueChoicePredicate	field (string, required), values (array, required)	Matches a column against a set of concrete values.
IntegerIdChoicePredicate	field (string, default id), ids (array, required)	Matches an integer ID column against a set of IDs.
PublishedPredicate	published_field (?string, default null), start_field (?string, default null), stop_field (?string, default null), invert_published (bool, default false), now (int, required)	Standard Contao published/start/stop visibility check.
SearchKeywordsPredicate	value (string, required), columns (array, required)	Keyword search across one or more columns.
SimpleEquationPredicate	operand_left (string, required), operator (SqlEquationOperator|string, required), operand_right (string|int|null, default '')	Generic column <operator> value equation (=, !=, >, >=, <, <=, LIKE, ...).

To write your own, implement PredicateInterface (or extend AbstractPredicate) — registration is automatic via the flare.filter_predicate service tag. See the predicates guide.