deleteable) filter for doctrine in symfony

Installing and using SoftDeleteable behavior extension for Doctrine 2 is quite easy. The problem usually is trying to disable it for some code part and enabling again. You may want to do this to:

  • load entity that is soft-deleted
  • remove entity from database entirely bypassing soft-delete filter
  • So how to disable it?


    1. How to load soft-deleted entity

    As per the documentation, disable filter for entity manager:

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

    To enable soft-delete again:

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

    Note: $em->clear(); may be required before this line, if entity was already loaded with disabled soft-delete filter.

    2. How to remove entity from database entirely

    Even though it is not mentioned in documentation, the first solution does not work if you need to remove entity and bypass soft-delete filter. Filter needs to be removed from entity manager's event listeners:

    // 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);
    }
    

    References:

  • 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

  • You can use a service to disable and reenable the soft delete filter behaviour:

    <?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);
        }
    }
    

    usage:

    $this->softDeleteFilter->removeSoftDeleteFilter($this->entityManager);
    $this->entityManager->remove($issue);
    $this->entityManager->flush();
    $this->softDeleteFilter->undoRemoveSoftDeleteFilter($this->entityManager);
    
    链接地址: http://www.djcxy.com/p/65036.html

    上一篇: Symfony2:暂时禁用softdelete

    下一篇: 可删除)在symfony中过滤原则