Filtering on Nested Properties does not work with QueryParameter

[dlubitz]

API Platform version(s) affected: 4.2.3

Description
Filtering on nested properties does not work, if I use QueryParameter to define the filter:

new GetCollection(
    parameters: [
        'street' => new QueryParameter(
            filter: new PartialSearchFilter(),
            property: 'address.street',
        ),
    ]
)

This results in a SQL error:

[Semantical Error] line 0, col 248 near 'street) LIKE': Error: Class App\\Entity\\Volunteer has no field or association named address.street

If I use the deprecated ApiFilter it works for me:

#[ApiFilter(SearchFilter::class, properties: ['address.street' => 'partial'])]

[soyuka]

Filtering on nested properties requires joins which is hard to predict and may lead to unwanted behavior / performance issues, can't you create your own filter?

[dlubitz]

Thanks for reaching out. Not sure, will check this. But I assumed the QueryParameter filter will replace the ApiFilter with the same feature set. So it's intended for the new QueryParameter to not support nested properties? If yes, I can close this issue.

[soyuka]

I don't think it'll provide "the same feature set" as many of those features were quite broken, still I think we'll continue to support the current SearchFilter, it should work with the query parameter:

        'searchPartial[:property]' => new QueryParameter(filter: 'app_search_filter_partial'),

with :

#[ApiFilter(SearchFilterValueTransformer::class, alias: 'app_search_filter_partial', properties: ['foo' => 'partial'], arguments: ['key' => 'searchPartial'])]

But instead of using the ApiFilter you should declare the service manually it's cleaner and future proof (check our SearchFilterValueTransformer in the codebase it's using the original search filter).