spiriitlabs / form-filter-bundle

v12.3.0 2026-09-07 08:52 UTC

Requires

• php: ^8.1
• doctrine/orm: ^3.0
• symfony/deprecation-contracts: ^3.5
• symfony/form: ^5.4|^6.4|^7.4|^8.0
• symfony/framework-bundle: ^5.4|^6.4|^7.4|^8.0
• symfony/http-foundation: ^5.4|^6.4|^7.4|^8.0
• symfony/routing: ^5.4|^6.4|^7.4|^8.0

Requires (Dev)

• doctrine/annotations: ^2.0
• doctrine/doctrine-bundle: ^1.8 || ^2.0 || ^3.0
• rector/rector: ^2.0
• symfony/phpunit-bridge: ^5.4|^6.4|^7.4|^8.0
• symfony/security-csrf: ^5.4|^6.4|^7.4|^8.0
• symfony/var-dumper: ^5.4|^6.4|^7.4|^8.0
• symfony/var-exporter: ^5.4|^6.4|^7.4
• symfony/web-profiler-bundle: ^5.4|^6.4|^7.4|^8.0
• symfony/yaml: ^5.4|^6.4|^7.4|^8.0
• symplify/easy-coding-standard: ^12.5
• twig/twig: ^3.0

Suggests

• symfony/web-profiler-bundle: To inspect in the web debug toolbar which form field produced which DQL condition

MIT

• symfony
• admin
• form
• search
• doctrine
• filter
• datatable
• criteria
• backoffice
• listing
• query-builder
• symfony-bundle
• doctrine-orm
• dynamic-filter
• search-form

Published on Packagist.org on 2026-09-07 08:53 UTC

README

Build a Symfony form dedicated to filtering an entity, then let the bundle turn it into Doctrine ORM query builder conditions.

LexikFormFilterBundle is now SpiriitFormFilterBundle: only the name and the GitHub organization changed, the code remains the same.

📖 Full documentation: spiriitlabs.github.io/form-filter-bundle

The idea is:

1. Create a form type extending Symfony\Component\Form\AbstractType, as usual.
2. Add fields using the provided filter types (e.g. TextFilterType::class instead of TextType::class).
3. Call FilterBuilderUpdater to build the query from the form instance, then execute it.

Any type works, but filtering on a type other than a XxxFilterType::class requires a custom listener to apply the filter.

Installation

composer require spiriitlabs/form-filter-bundle

Requires PHP 8.1+ and Symfony 5.4+. For Symfony 2.8/3.4, use the latest v5.* tag.

Use it in two steps

1. Create a filter form

<?php

namespace Project\Form\Filter;

use Spiriit\Bundle\FormFilterBundle\Filter\Form\Type as Filters;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilderInterface;

class RankFilterType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder->add('name', Filters\TextFilterType::class);
        $builder->add('rank', Filters\NumberFilterType::class);
    }
}

2. Apply it to a query builder

class DefaultController extends AbstractController
{
    public function __invoke(
        Request $request,
        FormFactoryInterface $formFactory,
        EntityManagerInterface $em,
        FilterBuilderUpdater $filterBuilderUpdater,
    ): Response {
        $form = $formFactory->create(RankFilterType::class);
        $form->handleRequest($request);

        $filterBuilder = $em->getRepository(MyEntity::class)->createQueryBuilder('e');

        $filterBuilderUpdater->addFilterConditions($form, $filterBuilder);

        // now look at the DQL =)
        dump($filterBuilder->getDql());

        return $this->render('testFilter.html.twig', ['form' => $form]);
    }
}

Documentation

• Installation
• Basics
• Configuration
• Provided filter types
• Filter state persistence
• Debugging & profiler

Community support

Please open a question on StackOverflow using the spiriitformfilterbundle tag, the official support platform for this bundle. GitHub issues are dedicated to bug reports and feature requests.

Credits

• Spiriit [e-mail]
• All contributors

License

This bundle is under the MIT license. For the whole copyright, see the LICENSE file distributed with this source code.