api-platform filter out the soft deleted items

user_2032751 0
Viewed 1200

I have setup the soft delete for my Store entity by using softdelete.

This is my filter setup in the doctrine.yml:

doctrine:
    # ...
    orm:
        # ...
        filters:
            softdeleteable:
                class: Gedmo\SoftDeleteable\Filter\SoftDeleteableFilter
                enabled: true

So when I hit e.g. the URL /stores only the active stores are returned, but if I change the config to enabled: false it will give me all the results including deleted items, which is correct.

Now what I want to achieve is pass a query parameter from front-end like /stores?deleted=1 and then I want to get all the data, if no deleted=1 found only the active items

api-platform.com symfony doctrine-orm php
2 Answers

Why not create an event listener that uses the Request object and Doctrine's entity manager, and disables this filter? Something like this:

class FilterListener implements EventSubscriberInterface
{
    private $entityManager;

    public function __construct(EntityManagerInterface $entityManager)
    {
        $this->entityManager = $entityManager;
    }

    public static function getSubscribedEvents(): array
    {
        return [
            RequestEvent::class => 'onKernelRequest',
        ];
    }

    public function onKernelRequest(RequestEvent $event)
    {
        if (!$event->isMasterRequest()) {
            return;
        }

        $request = $event->getRequest();
        if ($request->query->getBoolean('deleted')) {
            $this->entityManager->getFilters()->disable('softdeleteable');
        }
    }
}
user_11162300

Since answer from @nico-haase didn't work for me, I am posting similar solution that works for me using Symfony 5.3 and Api Plarform 2.6:

class FilterSubscriber implements EventSubscriberInterface
{
    private $entityManager;

    public function __construct(EntityManagerInterface $entityManager)
    {
        $this->entityManager = $entityManager;
    }

    public static function getSubscribedEvents(): array
    {
        return [
            KernelEvents::REQUEST => ['modifyFilters', EventPriorities::PRE_READ],
        ];
    }

    public function modifyFilters(RequestEvent $event)
    {
        $request = $event->getRequest();
        // show deleted entities in case deleted param is provided
        if ($request->query->getBoolean('deleted')) {
            $this->entityManager->getFilters()->disable('softdeleteable');
        }
    }
}
user_5201880
Related