vendor/gedmo/doctrine-extensions/src/SoftDeleteable/Filter/SoftDeleteableFilter.php line 118

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Doctrine Behavioral Extensions package.
  5.  * (c) Gediminas Morkevicius <gediminas.morkevicius@gmail.com> http://www.gediminasm.org
  6.  * For the full copyright and license information, please view the LICENSE
  7.  * file that was distributed with this source code.
  8.  */
  10. namespace Gedmo\SoftDeleteable\Filter;
  12. use Doctrine\ORM\EntityManagerInterface;
  13. use Doctrine\ORM\Mapping\ClassMetadata;
  14. use Doctrine\ORM\Query\Filter\SQLFilter;
  15. use Gedmo\SoftDeleteable\SoftDeleteableListener;
  17. /**
  18.  * The SoftDeleteableFilter adds the condition necessary to
  19.  * filter entities which were deleted "softly"
  20.  *
  21.  * @author Gustavo Falco <comfortablynumb84@gmail.com>
  22.  * @author Gediminas Morkevicius <gediminas.morkevicius@gmail.com>
  23.  * @author Patrik Votoček <patrik@votocek.cz>
  24.  */
  25. class SoftDeleteableFilter extends SQLFilter
  26. {
  27.     /**
  28.      * @var SoftDeleteableListener
  29.      */
  30.     protected $listener;
  32.     /**
  33.      * @var EntityManagerInterface
  34.      */
  35.     protected $entityManager;
  37.     /**
  38.      * @var array<string, bool>
  39.      * @phpstan-var array<class-string, bool>
  40.      */
  41.     protected $disabled = [];
  43.     /**
  44.      * @param string $targetTableAlias
  45.      *
  46.      * @return string
  47.      *
  48.      * @throws \Doctrine\DBAL\Exception
  49.      */
  50.     public function addFilterConstraint(ClassMetadata $targetEntity, $targetTableAlias)
  51.     {
  52.         $class = $targetEntity->getName();
  53.         if (true === ($this->disabled[$class] ?? false)) {
  54.             return '';
  55.         }
  56.         if (true === ($this->disabled[$targetEntity->rootEntityName] ?? false)) {
  57.             return '';
  58.         }
  60.         $config = $this->getListener()->getConfiguration($this->getEntityManager(), $targetEntity->name);
  62.         if (!isset($config['softDeleteable']) || !$config['softDeleteable']) {
  63.             return '';
  64.         }
  66.         $platform = $this->getConnection()->getDatabasePlatform();
  67.         $quoteStrategy = $this->getEntityManager()->getConfiguration()->getQuoteStrategy();
  69.         $column = $quoteStrategy->getColumnName($config['fieldName'], $targetEntity, $platform);
  71.         $addCondSql = $platform->getIsNullExpression($targetTableAlias.'.'.$column);
  72.         if (isset($config['timeAware']) && $config['timeAware']) {
  73.             $addCondSql = "({$addCondSql} OR {$targetTableAlias}.{$column} > {$platform->getCurrentTimestampSQL()})";
  74.         }
  76.         return $addCondSql;
  77.     }
  79.     /**
  80.      * @param string $class
  81.      *
  82.      * @phpstan-param class-string $class
  83.      *
  84.      * @return void
  85.      */
  86.     public function disableForEntity($class)
  87.     {
  88.         $this->disabled[$class] = true;
  89.         // Make sure the hash (@see SQLFilter::__toString()) for this filter will be changed to invalidate the query cache.
  90.         $this->setParameter(sprintf('disabled_%s', $class), true);
  91.     }
  93.     /**
  94.      * @param string $class
  95.      *
  96.      * @phpstan-param class-string $class
  97.      *
  98.      * @return void
  99.      */
  100.     public function enableForEntity($class)
  101.     {
  102.         $this->disabled[$class] = false;
  103.         // Make sure the hash (@see SQLFilter::__toString()) for this filter will be changed to invalidate the query cache.
  104.         $this->setParameter(sprintf('disabled_%s', $class), false);
  105.     }
  107.     /**
  108.      * @return SoftDeleteableListener
  109.      *
  110.      * @throws \RuntimeException
  111.      */
  112.     protected function getListener()
  113.     {
  114.         if (null === $this->listener) {
  115.             $em = $this->getEntityManager();
  116.             $evm = $em->getEventManager();
  118.             foreach ($evm->getListeners() as $listeners) {
  119.                 foreach ($listeners as $listener) {
  120.                     if ($listener instanceof SoftDeleteableListener) {
  121.                         $this->listener = $listener;
  123.                         break 2;
  124.                     }
  125.                 }
  126.             }
  128.             if (null === $this->listener) {
  129.                 throw new \RuntimeException('Listener "SoftDeleteableListener" was not added to the EventManager!');
  130.             }
  131.         }
  133.         return $this->listener;
  134.     }
  136.     /**
  137.      * @return EntityManagerInterface
  138.      */
  139.     protected function getEntityManager()
  140.     {
  141.         if (null === $this->entityManager) {
  142.             $getEntityManager = \Closure::bind(function (): EntityManagerInterface {
  143.                 return $this->em;
  144.             }, $this, parent::class);
  146.             $this->entityManager = $getEntityManager();
  147.         }
  149.         return $this->entityManager;
  150.     }
  151. }