Contracts Reference

Flare exposes a set of small interfaces that opt a filter element, list type, or helper object into specific behavior.

Most custom filter elements extend AbstractFilterElement and most custom list types extend AbstractListType. Those base classes already implement several contracts with no-op or default behavior, so you only need to override the contracts that matter for your type.

Contracts are grouped into three categories:

1. Filter Element Contracts

• FormTypeOptionsContract: Dynamically modify Symfony form field options and generated choices.
• HydrateFormContract: Hydrate non-submitted form fields for non-intrinsic filters.
• IntrinsicValueContract: Provide values for intrinsic filters when no runtime value exists.
• RuntimeValueContract: Normalize runtime values before the filter invoker sees them.

2. List Type Contracts

• ConfigureQueryContract: Register joins and customize the base SQL query.
• DataContainerContract: Resolve the list record's dc value during backend editing.

3. General Contracts

• IsSupportedContract: Hide unsupported services from bundle integrations that check availability.
• PaletteContract: Return or adjust Contao DCA palette strings during palette building.