PartialSearchFilter and ExactFilter don't discover property name of filter with `:property` placeholder

[dlubitz]

API Platform version(s) affected: 4.2.2

Description
If I try to use the new ApiPlatform\Doctrine\Orm\Filter\PartialSearchFilter or ApiPlatform\Doctrine\Orm\Filter\ExactFilter in combination of a :property placeholder as the example in the docs , the filters throw an exception, as the property name is null.

If I add one of the filter directly to a parameter, the filter works fine.

How to reproduce

<?php
// api/src/Resource/Book.php

#[ApiResource(operations: [
    new GetCollection(
        parameters: [
            // This WILL restrict to only title and author properties
            'search[:property]' => new QueryParameter(
                properties: ['title', 'author'], // Only these properties get parameters created
                filter: new PartialSearchFilter()
            )
        ]
    )
])]
class Book {
    // ...
}

Exception:

ApiPlatform\\Doctrine\\Orm\\Util\\QueryNameGenerator::generateParameterName(): Argument #1 ($name) must be of type string, null given, called in /var/www/html/backend/vendor/api-platform/doctrine-orm/Filter/PartialSearchFilter.php on line 37

https://github.com/api-platform/core/blob/main/src/Doctrine/Orm/Filter/PartialSearchFilter.php#L31-L37

Possible Solution
T.B.D.

[dlubitz]

See also #7495

[vinceAmstoutz]

@dlubitz Please refer to #7483 (comment) and also the FreeTextQueryFilter documentation which allows filtering allows you to apply a single filter across a list of properties.

[dlubitz]

Thanks @vinceAmstoutz But the FreeTextQueryFilter-Example is a different usecase: It's for filtering a searchword in many properties (A). The example above should allow the filtering selective on different properties (B).

A) Search for "Nick" in field title and/or author
B) Search for "Nick" in field title and "Smith" in author

(edit)
To clarify: The result of the example above should be the same as, if you would define a filter for each property.

#[ApiResource(operations: [
    new GetCollection(
        parameters: [
            'search[title]' => new QueryParameter(
                property: 'title', 
                filter: new PartialSearchFilter()
            ),
            'search[author]' => new QueryParameter(
                property: 'author', 
                filter: new PartialSearchFilter()
            )
        ]
    )
])]

Or did got the :property placeholder wrong?

[vinceAmstoutz]

@dlubitz In your case, as you can see here the best option is:

#[ApiResource(operations: [
    new GetCollection(
        parameters: [
            'search[:property]' => new QueryParameter(
                properties: ['title', 'author']
                filter: new PartialSearchFilter()
            ),
           
        ]
    )
])]

[dlubitz]

But this is the same code as in the example and above! And this is not working for me. 🤔

[vinceAmstoutz]

But this is the same code as in the example and above! And this is not working for me. 🤔

Oh yes 😴

Could you please try with this ?

#[ApiResource(operations: [
    new GetCollection(
        parameters: [
            'a' => new QueryParameter(
                property: 'title', 
                filter: new PartialSearchFilter()
            ),
            'b' => new QueryParameter(
                property: 'author', 
                filter: new PartialSearchFilter()
            )
        ]
    )
])]

[dlubitz]

Yes, this works fine. But not the expanding of the :property placeholder.

[vinceAmstoutz]

Yes, this works fine. But not the expanding of the :property placeholder.

Thanks for the test @dlubitz! Looks like we have a bug here with this syntax @soyuka

[Coffee2CodeNL]

I also have this bug

[Vinarnt]

The problem lies in the ParameterResourceMetadataCollectionFactory service.

The parameter expansion is done only if the parameter key equals :property, when used in the bracketed form it doesn't expand.

On my end, I fixed it with this condition block:

if (str_contains($key, ':property')) {
    foreach ($propertyNames as $property) {
        $converted = $this->nameConverter?->denormalize($property) ?? $property;
        $propertyParameter = $this->setDefaults($converted, $parameter, $resourceClass, $properties, $operation);
        $priority = $propertyParameter->getPriority() ?? $internalPriority--;
        $finalKey = str_replace(':property', $converted, $key);
        $parameters->add(
            $finalKey,
            $propertyParameter->withProperty($converted)->withPriority($priority)->withKey($finalKey)
        );
    }

    $parameters->remove($key, $parameter::class);
    continue;
}

That's not a definitive solution as it wont enter the other condition, generating wrong documentation for some filters, for example the OrderFilter.
This filter rely solely on the extra properties, missing when applying the above fix, and the initial parameter key without expansion.