Filter Form Types

Filter Form Types are PHP classes that represent filters and extend standard Symfony form types. Each filter form type is a compound and consists of two fields:

a field for filter value (named “value”)
a field for filter operator (named “type”)

The following filters form types are available:

Class	Name	Short Description
FilterType	oro_type_filter	Basic type for all filters, declares two children, value and type
TextFilterType	oro_type_text_filter	Represents text filter form
NumberFilterType	oro_type_number_filter	Represents number filter form
NumberRangeFilterType	oro_type_number_range_filter	Represents number range filter form
ChoiceFilterType	oro_type_choice_filter	Represents choice filter form
EntityFilterType	oro_type_entity_filter	Represents entity filter form
BooleanFilterType	oro_type_boolean_filter	Represents boolean filter form
DateRangeFilterType	oro_type_date_range_filter	Represents date filter form
DateTimeRangeFilterType	oro_type_datetime_range_filter	Represents date and time filter form
DateRangeType	oro_type_date_range	This form type is used by oro_type_date_range_filter as field type
DateTimeRangeType	oro_type_datetime_range	This form type is used by oro_type_datetime_range_filter as field type
DateGroupingFilterType	oro_type_date_grouping_filter	Represents date grouping filter
SkipEmptyPeriodsFilterType	oro_type_skip_empty_periods_filter	Represents skip empty periods filter

oro_type_text_filter Form Type

Inherit Options

field_type
field_options
operator_choices
operator_type
operator_options
show_filter

Default Options

field_type = text
operator_choices
- TextFilterType::TYPE_CONTAINS
- TextFilterType::TYPE_NOT_CONTAINS
- TextFilterType::TYPE_EQUAL

Parent Type

oro_type_filter

Class

Oro\Bundle\FilterBundle\Form\Type\Filter\TextFilterType

oro_type_date_range Form Type

Children

start
end

Options

field_type
field_options
start_field_options
end_field_options

Default Options

field_type = “date”

Class

Oro\Bundle\FilterBundle\Form\Type\DateRangeType

Options Description

field_type - This option declares type of start and end child elements.
field_options - Value of this option will be used as options array for start and end fields.
start_field_options - Value of this option will be used as options array for start field.
end_field_options - Value of this option will be used as options array for end field.

oro_type_datetime_range Form Type

Default Options

field_type = “datetime”

Parent Type

oro_type_date_range

Class

Oro\Bundle\FilterBundle\Form\Type\DateTimeRangeType

Example of Usage

You can use filter form types as any other form type in Symfony. For example, consider you have a form with three filters. In your form type you should add code like this:

class MyFilterFormType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        // Add some form fields
        // ...
        // Add filters
        $builder->add('name', TextFilterType::class);
        $builder->add('salary', NumberFilterType::class);
        $builder->add('hobby', ChoiceFilterType::class, [
        field_options' => [
                'choices' => [1 => 'Coding', 2 => 'Hiking', 3 => 'Photography'],
                'multiple' => true
            ]
        ]);
    }
}

References

Symfony 2 Form Types
- Create Custom Field Type
- Types

Filter Form Types

oro_type_filter Form Type

oro_type_text_filter Form Type

oro_type_number_filter Form Type

oro_type_number_range_filter Form Type

oro_type_choice_filter Form Type

oro_type_entity_filter Form Type

oro_type_boolean_filter Form Type

oro_type_date_range_filter Form Type

oro_type_datetime_range_filter Form Type

oro_type_date_range Form Type

oro_type_datetime_range Form Type

oro_type_date_grouping_filter Form Type

oro_type_skip_empty_periods_filter Form Type

Example of Usage

References