The Filter System

Not sure if I missed something in a previous step, but adding the filters to QuestionCrudController resulted in an Exception being thrown:

`strlen(): Argument #1 ($string) must be of type string, null given`

I modified line 38 of `src/EasyAdmin/TruncateLongTextConfigurator.php`
to be

`if (null === $field->getFormattedValue() || strlen($field->getFormattedValue()) <= self::MAX_LENGTH) {`

and all is good

// or use null-coalesce
if (strlen($field->getFormattedValue() ?? '') <= self::MAX_LENGTH)
// or cast to string
if (strlen((string)$field->getFormattedValue()) <= self::MAX_LENGTH)
// or use strval function
if (strlen(strval($field->getFormattedValue())) <= self::MAX_LENGTH)

Hey Chris N.

I don't think you missed something, it looks like you hit a tiny sneaky bug on the TruncateLongTextConfigurator logic. Since it works with all the Textarea fields, it should assume that there will be fields with null values, so, your solution looks good to me

Cheers!

Maybe would be helpful for someone, Intellij tip: Instead of Ctrl+O and typing method name (3:58), you could just try start typing method name for autocompletion (IDK how this feature called in Intellij). Benefits:

• you're able to type not only for methods that can be overridden (Ctrl+O), but also which can be implemented (Ctrl+I), and setters/getters, magic methods, some stubs from Code Generate (Alt+I) and other things, like accessing methods/properties, handy shortcuts like prif/pubf/pubsf/etc. (in class body), thr/forek/etc. (in method body).
• smart search (alphabetic semantic) for typed characters: they can be shortened, for instance, conff will give just one suggestion for overriding configureFilters, since it sees, that configureFields already overridden. Or confa would suggest configureAssets. When you're completely lazy, you could type am/af with high chance that it would suggest array_map/array_filter, depending on context of caret position and just hit Enter.

I also like shortening in commands names symfony console m:a:d, symfony console m:a:c, symfony console m:vo.

Thanks for sharing it with others!

Hello, I have EntityFilter for Categories.
Could I add autocomplete and paging to this option list in the filter as in AssotiationField?
https://prnt.sc/W8rjbXwkDqPR

Yo @Ruslan-A!

Hmm. So you want to basically add the AJAX-powered autocomplete and pagination to the filter, correct? Yea, I don't see an easy way to do that, unfortunately :/. In theory, I THINK if you were able to add a data-ea-autocomplete-endpoint-url attribute to the select element set to the autocomplete URL, then it might work. That is how the normal AssociationField works: https://github.com/EasyCorp/EasyAdminBundle/blob/4.x/src/Field/Configurator/AssociationConfigurator.php#L139-L158

So, it might be possible - you CAN call ->add(EntityFilter::new('topic')->setFormTypeOption(...)) but I have no idea if it will actually work. But I'd love to know if you get it working!

Cheers!

Hello there thanks for this clear course i have a question. i want to display filters directly on crud page i overided the index page of the crud but when modifing the block filters i can't use form_widget to display the filterform. any response in this topic will be helpfull thanks

Hi @Marouane-M!

Ah, interesting! EasyAdmin actually loads those filters via an Ajax call, so I'm not surprised that you're missing some variables when you try to render them in the main template. I've never tried what you're attempting, but the form and rendering of the filter form is actually done in AbstractCrudController::renderFilters(): https://github.com/EasyCorp/EasyAdminBundle/blob/be6a5f8dab930b36973329dfb6505b3774cfe8ee/src/Controller/AbstractCrudController.php#LL478C21-L478C34

You could, in theory, copy some of the code from this method and pass the missing variable into your template (perhaps by overriding index() ?) Another option would be to continue to load this via Ajax, but load it immediately after the page loads. You can see how the URL is built to this AJAX call here: https://github.com/EasyCorp/EasyAdminBundle/blob/be6a5f8dab930b36973329dfb6505b3774cfe8ee/src/Resources/views/crud/index.html.twig#L54

I hope these hints help - let me know if you get it working!

Cheers!

Many thanks! I have a little question. How to make a filter preselected? for example date in exercise enabled = true; or date preselect to current date?
I would suggest using AdminUrlGenerator, but this is a theory. Thank you in Advance

Hey Alexey,

For this, you need to understand how filters work. EA filters work by query parameters, so to make the filter pre-enabled by default - you need to pass some specific parameters in the URL. Which exactly? You can enable and apply that filter and check the URL to know the correct extra parameters. And then, for the link that you want to click and see the filter pre-enabled - I suppose you want to do it for the link in the dashboard menu - you need to add those extra parameters. Then every time you will click that link - filter will be pre-enabled. That's not simple, but should do the trick :)

I hope this helps!

Cheers!

Hi,
I created 2 custom filters, as in the documentation. Each of the filters works perfectly, but both don't. The query is applied with the last filter, ignoring the first filter ($filterDataDto->getValue()

The two filters are the same entitytype (Many to one)

class AssociationFilter implements FilterInterface
{
    use FilterTrait;
    public static function new(string $propertyName, $label = null): self
    {
        return (new self())
            ->setFilterFqcn(__CLASS__)
            ->setProperty($propertyName)
            ->setLabel($label)
            ->setFormType(AssociationFilterType::class);
    }
    public function apply(QueryBuilder $queryBuilder, FilterDataDto $filterDataDto, ?FieldDto $fieldDto, EntityDto $entityDto): void
    {

        if ('' !== $filterDataDto->getValue()) {
            $queryBuilder
                ->andWhere('entity.association = :value')
                ->setParameter('value', $filterDataDto->getValue());
        }
    }
}

for the other filter

    public static function new(string $propertyName, $label = null): self
    {
        return (new self())
            ->setFilterFqcn(__CLASS__)
            ->setProperty($propertyName)
            ->setLabel($label)
            ->setFormType(CoupleFilterType::class);
    }
    public function apply(QueryBuilder $queryBuilder, FilterDataDto $filterDataDto, ?FieldDto $fieldDto, EntityDto $entityDto): void
    {

        if ('' !== $filterDataDto->getValue()) {
            $queryBuilder
                ->andWhere('entity.couple = :value')
                ->setParameter('value', $filterDataDto->getValue());
        }
    }

the request takes the same Id for couple and association.

SELECT count(DISTINCT d0_.id) AS sclr_0 FROM dance d0_ LEFT JOIN couple c1_ ON d0_.couple_id = c1_.id LEFT JOIN association a2_ ON d0_.association_id = a2_.id WHERE d0_.couple_id = ? AND d0_.association_id = ? AND d0_.association_id IN (?, ?, ?, ?)
Parameters:
[▼
  57
  57
  55
  56
  57
  59
]

Thank's for your help.
Alan from France

Hey Delenclos,

Please, first, make sure you hit both filters, e.g. add some dump statements in both to see if they both are called. Also, just in case, clear the cache, I'd recommend to do it with rm -rf var/cache/ just in case. But fairly speaking, I see that the final query holds both entity.association and entity.couple fields, so I may suppose it should work well because it's in the query?

Cheers!

Hi,

I found the solution, it's just because the parameter name (:value) must be different in each apply custom filter function. Thank's for all.

Alain

Hey Delenclos,

Awesome, thanks for sharing the final solution with others! Yep, it should be unique, otherwise it will be overwritten in the URL :)

Cheers!

Hi all,

actually, the search filter opens a modal with all filters added; is there a way to customize or override the template for filters container?
let you want to do something different from opening a modal ... can we do this ?

thanks in advance!

Hi Gianluca-F!

Sorry for the slow reply - we're all getting back from Symfony conference week :).

So, let's see...

is there a way to customize or override the template for filters container?

Probably, though depending on what you want to do, simply overriding the template for the modal may not give you what you need. The template lives here: https://github.com/EasyCorp/EasyAdminBundle/blob/4.x/src/Resources/views/crud/includes/_filters_modal.html.twig

And so, you should be able to follow Symfony's normal process for overriding a template from a bundle: https://symfony.com/doc/current/bundles/override.html#templates

let you want to do something different from opening a modal ... can we do this ?

I am more doubtful that this is possible... at least easily. The code that renders the "Filters" button lives here: https://github.com/EasyCorp/EasyAdminBundle/blob/76d8585b25d400a75234d714a83962d76ab0aeb1/src/Resources/views/crud/index.html.twig#L49-L65

You can see the <a> tag that is built to work with the Bootstrap modal. In theory, you could override this template... and try to change JUST that area. Or, you could allow this to render like normal, but then add some custom JavaScript to try to override the modal behavior and do something different. It may or may not be super tricky, depending on what you need to do. But hopefully this can help :).

Cheers!

I just have a very last question! Is it in EntityFilter's somehow possible to control the query which is responsible to create the filter-options which are shown in the select-form? It just fetching all the data but I would like to apply some exclude conditions, but I have no idea how to access the query-builder. This should be somehow possible, but there is really no documentation. Thanks!

Hey again!

Yes, good question :). I think the answer may be similar to your previous question. There are two fields for each filter the "comparison field" (e.g. equals, less than, etc) and the "value field", which in this case would be the select menu of options. Both of these are confirable. I would try something like:

->setFormTypeOptions([
    'value_type_options' => ['query_builder' => function(...) {}],
]);

If I'm reading the code correctly, for an EntityFilter, internally, it will use an EntityType for that select element and pass value_type_options TO that EntityType. So whatever options EntityType has, you should be able to pass those to value_type_options.

Let me know how that goes!

Cheers!

Thank you very much, it works! Once again you solved my problem :-D! I looked in the EntityFilterType, EntityType, Filter-Configurators and even in the templates, but I had no luck. I think the filter should provide a helper-method or at least, this should be somehow mentioned in the documentation.

Yay! Yea, this isn't a use-case I had ever thought of (modifying the filters), but now that you mention it, it probably should be documented. If you have some time, you could add a section here - https://github.com/EasyCorp/EasyAdminBundle/blob/4.x/doc/filters.rst - e.g. Advanced Filter Configuration where you mention these options we've learned about.

Cheers!

Thank you, this is a good idea. I think, having access to the query-builder on filters should be also very common, maybe to exclude entities which are marked as deleted and so on. Cheers!

Hello! Is it somehow possible to hide these comparison-options in EntityFilters? I want only provide "is equal" without this select-box. Sadly there is nothing in the documentation which options I can provide to the EntityFilter or to any Filter. I also tried to find this part in the view to maybe override the template.

Hey Szabolcs!

Ah, that's an interesting question! So here's the flow:

A) You use the EntityFilter directly from EasyAdmin - https://github.com/EasyCorp/EasyAdminBundle/blob/4.x/src/Filter/EntityFilter.php
B) Internally, its form type is EntityFilterType: https://github.com/EasyCorp/EasyAdminBundle/blob/4.x/src/Form/Filter/Type/EntityFilterType.php
C) That class extends (via getParent()) several classes, but eventually ComparisonFilterType - https://github.com/EasyCorp/EasyAdminBundle/blob/4.x/src/Form/Filter/Type/ComparisonFilterType.php
D) ComparisonFilterType adds a comparison field set to ComparisonType, which is the field that, finally, shows the "select box" with things like "is equal", etc.

So, how can you hook into this? I'm doing some guessing, but I can think of a few ways:

1) You could call ->setFormTypeOption('comparison_type_options', ['choices' => ['filter.label.is_same' => ComparisonType::EQ]]); on your filter field in your controller. I believe this would change the choice to only show the ONE option. Not exactly what you were asking for, but closer.
2) You might also be able to change this to a hidden field, via:

->setFormTypeOption('comparison_type_options', [
    'comparison_type' => HiddenType::class,
    'comparison_type_options' => ['data' => ComparisonType::EQ],
])

I might be missing something, but that should change the select field to a hidden field... and then set the data on the hidden field to the "equal" value so that everything works.

There are also other options - like using a form type extension to more directly alter one of the fields. But try this first :).

Cheers!

Hi Ryan

thank you very much for your answer! This solution throws a nice error :-D, it says >The options "comparison_type", "comparison_type_options" do not exist<. I think I tried this before.

I also don't know, what is the approach when I want to place some filter (or an action-button) on a complete different place in the template - in my admin-tool, the admin-users must select some categories at first in order to continue and so on.

I have to say, building CRUD-based controllers in API-Platform and just write the frontend-logic in Vue or in React is much easier. For a simple todo-list, easyAdmin works, but when it comes to a little complexity, it is really difficult to customize it.

but this worked:

->setFormTypeOptions([
    'comparison_type' => HiddenType::class,
    'comparison_type_options' => ['data' => ComparisonType::EQ],
]);

Thank you very much, you still helped me a lot!

Perfect! Thanks for sharing the solution!

Hello! I just want to mention, that this solution to hiding the comparison-options (which are in most cases not necessary) leads to an error when I use multiple entity-filters. This error appears:

EasyCorp\Bundle\EasyAdminBundle\Dto\FilterDataDto::getComparison(): Return value must be of type string, null returned<br />

With only one filter, it works fine. So my solution ist just to hide them with css :-D

form[name=filters] .filter-content .form-widget-compound > div > div:first-child {
    display: none;
}

I really really recommend to avoid this easy-admin-bundle and use api-platform to implement crud-action and build the UI's with Vue or React.

Hey Szabolcs!

Ah, that's a shame! I'm guessing there is a way to work around that, but your solution is fine of course - thanks for sharing!

I really really recommend to avoid this easy-admin-bundle and use api-platform to implement crud-action and build the UI's with Vue or React.

I really like EasyAdmin - but it's a fair point - we have multiple excellent options :).

Cheers!

Many thanks! I have a little question. Can we change the display name of the intities inside the filter? Because I've already changed the entities names in the table and they don't look the same right now.

Hey Lubna!

That's an excellent question! So, for a relation filter, you're using EntityFilter: https://github.com/EasyCorp/EasyAdminBundle/blob/4.x/src/Filter/EntityFilter.php. Behind the scenes, the form type for that filter is EntityFilterType: https://github.com/EasyCorp/EasyAdminBundle/blob/025bc2b5e5add6961c884dca7338e01c20f4c71f/src/Filter/EntityFilter.php#L33

So let's look at that class: https://github.com/EasyCorp/EasyAdminBundle/blob/4.x/src/Form/Filter/Type/EntityFilterType.php

Notice it has a "value_type" of EntityType. I don't really know how "value_type" is used, but it sounds like, at some level, it's using EntityType to build the filter form element. That EntityFilterType's "parent type" is ChoiceFilterType, which means it inherits all of its options: https://github.com/EasyCorp/EasyAdminBundle/blob/4.x/src/Form/Filter/Type/ChoiceFilterType.php

Finally, here we can see how value_type is used and also there is a value_type_options option. Since we know that the EntityType's "display" can be controlled via the "choice_label" option (ref: https://symfonycasts.com/screencast/easyadminbundle/association-many#configuring-the-choice-label-field-option), we can put the whole thing together. I believe it would look like this (inside configureFilters):

->add(
    EntityFilter::new('topic')->setFormTypeOption('value_type_options', [
        'choice_label' => 'name' // where "name" is the property on Topic to use. Or pass a callback to this
    ])
)

It's very possible I messed up some syntax here, but the idea should work: we pass a "form type option" to EntityFilter called "value_type_options". This is eventually passed to EntityFilterType/ChoiceFilterType, which uses it when constructing the EntityType to build that field.

Phew! Let me know if that works.

Cheers!