Custom Filter does not work

API Platform version(s) affected: 2.6.1

Description
Custom filter is registered, but does nothing.

How to reproduce

<?php
// api/src/Filter/RegexpFilter.php

namespace App\Filter;

use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\AbstractContextAwareFilter;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
use Doctrine\ORM\QueryBuilder;

final class IsNotFilter extends AbstractContextAwareFilter
{
    protected function filterProperty(string $property, $value, QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null)
    {
        // otherwise filter is applied to order and page as well
        if (
            !$this->isPropertyEnabled($property, $resourceClass) ||
            !$this->isPropertyMapped($property, $resourceClass)
        ) {
            return;
        }

        $parameterName = $queryNameGenerator->generateParameterName($property); // Generate a unique parameter name to avoid collisions with other filters
        $queryBuilder
            ->andWhere(sprintf('1 != 1', $parameterName, $property))
            ->setParameter($parameterName, $value);
    }

    // This function is only used to hook in documentation generators (supported by Swagger and Hydra)
    public function getDescription(string $resourceClass): array
    {
        if (!$this->properties) {
            return [];
        }

        $description = [];
        foreach ($this->properties as $property => $strategy) {
            $description["is_not_$property"] = [
                'property' => $property,
                'type' => 'string',
                'required' => false,
                'swagger' => [
                    'description' => 'Filter for relations that are not the specific entity.',
                    'name' => 'Is Not Filter',
                    'type' => 'Custom Filter',
                ],
            ];
        }

        return $description;
    }
}

Additional Context
Filter appears in graphql schema and I can use it in queries. However, it does not affect output in any way. For simplicity, I am using the ‘1 != 1’ condition for the andWhere in the sample code, but I’ve tried all kinds of queries that function fine in Repositories. Also tried to copy the SearchFilter code into a CustomFilter, same result.

[plamenh]

No, sorry. Never had the need to.

[plamenh]

@Vicolondon There are two issues with their example:

1. First, the property name is not properly passed to the filterProperty function. Basically, if you name your filter like this - $description["is_not_$property"], then you need to transform the $property in the filterProperty function like that - $property = str_replace('is_not_', '', $property);
2. The $this->isPropertyMapped($property, $resourceClass) check always returns false. Not sure, if it is related to the above issue or not.

So, to give you a working example:

<?php

namespace App\Filter;

use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\AbstractContextAwareFilter;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
use Doctrine\ORM\QueryBuilder;

final class IsNotFilter extends AbstractContextAwareFilter
{
    protected function filterProperty(
        string $property, 
        $value, 
        QueryBuilder $queryBuilder, 
        QueryNameGeneratorInterface $queryNameGenerator, 
        string $resourceClass, 
        string $operationName = null
    ) {
        $property = str_replace('is_not_', '', $property);

        // otherwise filter is applied to order and page as well
        if (
            !$this->isPropertyEnabled($property, $resourceClass) 
            // || !$this->isPropertyMapped($property, $resourceClass)
            || $value === 0
        ) {
            return;
        }


        $parameterName = $queryNameGenerator->generateParameterName($property); // Generate a unique parameter name to avoid collisions with other filters

        // throw new \Exception($parameterName);

        $queryBuilder
            ->andWhere(sprintf('o.%s != :%s OR o.%s is NULL', $property, $parameterName, $property))
            ->setParameter($parameterName, $value);
    }

    // This function is only used to hook in documentation generators (supported by Swagger and Hydra)
    public function getDescription(string $resourceClass): array
    {
        if (!$this->properties) {
            return [];
        }

        $description = [];
        foreach ($this->properties as $property => $strategy) {
            $description["is_not_$property"] = [
                'property' => $property,
                'type' => 'int',
                'required' => false,
                'swagger' => [
                    'description' => 'Filter for relations that are not the specific entity.',
                    'name' => 'Is Not Filter',
                    'type' => 'Custom Filter',
                ],
            ];
            // throw new \Exception(print_r($description));
        }

        return $description;
    }
}

I hope this helps.