SearchFilter: Refactor code to reduce code duplication and makes it easier to add new strategies to classes inheriting from SearchFilter class

[jpierront]

Q	A
Bug fix?	no
New feature?	no
BC breaks?	no
Deprecations?	no
Tickets
License	MIT
Doc PR	api-platform/docs#...

All query manipulations are now located in the same method to ease the creation on classes inherited from SearchFilter.

Example:

class ExtendedSearchFilter extends SearchFilter
{
public const STRATEGY_OTHER = 'other';
protected function addWhereByStrategy(string $strategy, QueryBuilder $queryBuilder, string $alias, string $field, $fieldType, $values, bool $caseSensitive, string $valueParameter)
{
if (self::STRATEGY_OTHER === $strategy) {
// ...
return;
}
parent::addWhereByStrategy($strategy, $queryBuilder, $alias, $field, $fieldType, $values, $caseSensitive, $valueParameter);
}
}

We will be able to create easily a "not_int" strategy or more complexe cases.

[jpierront]

I'm not sure of what I did for the MongoDbOdm part ;-)

[alanpoulain]

Seems nice! Could you add a Behat test to validate its behavior? It will allow to make sure MongoDB works too.

[alanpoulain]

It's a BC break.

[jpierront]

Finally, by creating the behat tests, I realized that my code was not really doing what I expected.

• Doing a "partial" search on "relatedDumies.name" was already working before my PR.
• Doing a "partial" search on "relatedDumies" (So on the identifier) is not accepted by Doctrine ORM (It doesn't accept to make a "LIKE" on identifier in this case)

Finally I’ll just keep the refactoring simplifying the creation of new strategies in the inherited classes. It was what I needed initially ;-)

[alanpoulain]

Since the class is final, it should be private.

[jpierront]

So we allow to extends the ORM version but not the ODM one ? :/

[alanpoulain]

Yes. Because the ORM version will also be a final class in the next major version (3.0).

[jpierront]

OK, so my original intention will lose its meaning in V3. ;-)
My refactoring still seems interesting to centralize the code related to the strategy in the same place.

[alanpoulain]

Even like this, it's a BC break. You should mimic what has been done here: #3521.

[alanpoulain]

Thanks @jpierront.