Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/spiriitlabs/form-filter-bundle

This Symfony bundle aim to provide classes to build some form filters and then build a doctrine query from this form filter.
https://github.com/spiriitlabs/form-filter-bundle

Last synced: 7 days ago
JSON representation

This Symfony bundle aim to provide classes to build some form filters and then build a doctrine query from this form filter.

Awesome Lists containing this project

README 

        
SpiriitFormFilterBundle

=====================



The LexikFormFilterBundle, a historical bundle, is now renamed to SpiriitFormFilterBundle. 

The code remains unchanged; only the name and organization have changed on GitHub.



------------------------------------------------------------------------------------------------



This Symfony bundle aims to provide classes to build some form types dedicated to filter an entity.

Once you created your form type you will be able to update a doctrine query builder conditions from a form type.



[![PHP Version](https://img.shields.io/packagist/php-v/spiriitlabs/form-filter-bundle)](https://packagist.org/packages/spiriitlabs/form-filter-bundle)

![Packagist Downloads](https://img.shields.io/packagist/dm/spiriitlabs/form-filter-bundle?style=flat-square&label=Downloads%20Monthly)

[![Latest Stable Version](https://poser.pugx.org/spiriitlabs/form-filter-bundle/v/stable.svg)](https://packagist.org/packages/spiriitlabs/form-filter-bundle)

[![CI Tests](https://github.com/SpiriitLabs/form-filter-bundle/actions/workflows/ci.yml/badge.svg)](https://github.com/SpiriitLabs/form-filter-bundle/actions/workflows/ci.yml)



The idea is:



1. Create a form type extending from `Symfony\Component\Form\AbstractType` as usual.

2. Add form fields by using provided filter types (e.g. use TextFilterType::class instead of a TextType::class type) (*).

3. Then call a service to build the query from the form instance and execute your query to get your result :).



(*): In fact you can use any type, but if you want to apply a filter by not using a XxxFilterType::class type you will 

have to create a custom listener class to apply the filter for this type.



## Installation

================



The bundle can be installed using Composer or the [Symfony binary](https://symfony.com/download):



```

composer require spiriitlabs/form-filter-bundle

```



## Use it in two steps



### create a form



```php

add('name', Filters\TextFilterType::class);

        $builder->add('rank', Filters\NumberFilterType::class);

    }

}

```



### use it in your controller



```php

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

=============



This Symfony bundle is compatible with Symfony 4.3 or higher.



For Symfony 2.8/3.4 please use tags v5.*



For installation and how to use the bundle refer to [Resources/doc/index.md](Resources/doc/index.md)



1. [Installation](Resources/doc/installation.md)

2. [Configuration](Resources/doc/configuration.md)

3. [Provided form types](Resources/doc/provided-types.md)

4. [Example & inner workings](Resources/doc/basics.md)

    1. [Simple example](Resources/doc/basics.md#i-simple-example)

    2. [Inner workings](Resources/doc/basics.md#ii-inner-workings)

5. [Working with the filters](Resources/doc/working-with-the-bundle.md)

    1. [Customize condition operator](Resources/doc/working-with-the-bundle.md#i-customize-condition-operator)

    2. [Filter customization](Resources/doc/working-with-the-bundle.md#ii-filter-customization)

    3. [Working with entity associations and embeddeding filters](Resources/doc/working-with-the-bundle.md#iii-working-with-entity-associations-and-embeddeding-filters)

    4. [Doctrine embeddables](Resources/doc/working-with-the-bundle.md#iv-doctrine-embeddables-orm)

    5. [Create your own filter type](Resources/doc/working-with-the-bundle.md#v-create-your-own-filter-type)

    6. [Enable validation on your filter type](Resources/doc/working-with-the-bundle.md#vi-enable-filtertype-form-validation)

6. [The FilterTypeExtension](Resources/doc/filtertypeextension.md)

7. [Working with other bundles](Resources/doc/working-with-other-bundles.md)

    1. [KNP Paginator example](Resources/doc/working-with-other-bundles.md#i-knp-paginator-example)

8. [Real use case - Advanced usage with PagerFanta](Resources/doc/advanced-usage-with-pagerfanta-bundle.md)   



Community Support

-----------------



Please consider [opening a question on StackOverflow](http://stackoverflow.com/questions/ask) using the [`spiriitformfilterbundle` tag](http://stackoverflow.com/questions/tagged/spiriitformfilterbundle),  it is the official support platform for this bundle.

  

Github Issues are dedicated to bug reports and feature requests.



For compatibility with Symfony 2.8 and 3.4

------------------------------------------



Please use last tag v5.*



Credits

-------



* Spiriit 

* [All contributors](https://github.com/SpiriitLabs/form-filter-bundle/graphs/contributors)



License

-------



This bundle is under the MIT license.  

For the whole copyright, see the [LICENSE](LICENSE) file distributed with this source code.