如何在symfony中禁用doctrine的软删除（软删除）过滤器

Posted 2021-03-28

为Doctrine 2安装和使用SoftDeleteable行为扩展非常简单。问题通常是尝试为某些代码部分禁用它并再次启用。您可能希望这样做：

1. 加载软删除的实体
2. 完全绕过软删除过滤器从数据库中删除实体

那么如何禁用它呢？

答案

1. How to load soft-deleted entity

根据文档，禁用实体管理器的过滤器：

$em->getFilters()->disable('softdeleteable');
$object = $em->find('AppBundle:Object', 1); // soft-deleted entity will be loaded

要再次启用软删除：

$em->getFilters()->enable('softdeleteable');

注意：如果实体已加载了禁用的软删除过滤器，则此行之前可能需要$em->clear();。

2. How to remove entity from database entirely

即使文档中没有提到，如果您需要删除实体并绕过软删除过滤器，第一个解决方案也不起作用。需要从实体管理器的事件侦听器中删除过滤器：

// initiate an array for the removed listeners
$originalEventListeners = [];

// cycle through all registered event listeners
foreach ($em->getEventManager()->getListeners() as $eventName => $listeners) {
    foreach ($listeners as $listener) {
        if ($listener instanceof GedmoSoftDeleteableSoftDeleteableListener) {

            // store the event listener, that gets removed
            $originalEventListeners[$eventName] = $listener;

            // remove the SoftDeletableSubscriber event listener
            $em->getEventManager()->removeEventListener($eventName, $listener);
        }
    }
}

// remove the entity
$em->remove($object);
$em->flush($object); // or $em->flush();

// re-add the removed listener back to the event-manager
foreach ($originalEventListeners as $eventName => $listener) {
    $em->getEventManager()->addEventListener($eventName, $listener);
}

参考文献：

• https://github.com/Atlantic18/DoctrineExtensions/blob/master/doc/softdeleteable.md
• Force delete doctrine entity when using SoftDeletable by KnpLabs
• Disable Soft Deleteable filter for hard delete record doesn't work

另一答案

您可以使用服务来禁用和启用软删除过滤器行为：

<?php

namespace AppUtil;

use DoctrineORMEntityManagerInterface;
use GedmoSoftDeleteableSoftDeleteableListener;

class SoftDeleteFilter
{
    /**
     * @var string
     */
    const EVENT_NAME = 'onFlush';

    /**
     * @var object
     */
    private $originalEventListener;

    /**
     * @param EntityManagerInterface $em
     */
    public function removeSoftDeleteFilter(EntityManagerInterface $em)
    {
        foreach ($em->getEventManager()->getListeners() as $eventName => $listeners) {
            foreach ($listeners as $listener) {
                if ($listener instanceof SoftDeleteableListener) {
                    if ($eventName === self::EVENT_NAME) {
                        $this->originalEventListener = $listener;
                        $em->getEventManager()->removeEventListener($eventName, $listener);
                    }
                }
            }
        }
    }

    /**
     * @param EntityManagerInterface $em
     */
    public function undoRemoveSoftDeleteFilter(EntityManagerInterface $em)
    {
        if (empty($this->originalEventListener)) {
            throw new Exception('can not undo remove, soft delete listener was not removed');
        }
        // re-add the removed listener back to the event-manager
        $em->getEventManager()->addEventListener(self::EVENT_NAME, $this->originalEventListener);
    }
}

用法：

$this->softDeleteFilter->removeSoftDeleteFilter($this->entityManager);
$this->entityManager->remove($entity);
$this->entityManager->flush();
$this->softDeleteFilter->undoRemoveSoftDeleteFilter($this->entityManager);

另一答案

正如在former comment发布的qooplmao中所说：一个简单而有效的解决方案是：

// Remove an entity entirely from the DB (skip soft delete)
$this->entityManager->remove($entity);
$this->entityManager->flush();
// Just run it a second time :-)
$this->entityManager->remove($entity);
$this->entityManager->flush();

只是再次发布它，让它更具可见性，因为它像一个魅力......