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

Open in your IDE?
  1. <?php
  3. namespace Gedmo\SoftDeleteable\Filter;
  5. use Doctrine\ORM\EntityManagerInterface;
  6. use Doctrine\ORM\Mapping\ClassMetadata;
  7. use Doctrine\ORM\Query\Filter\SQLFilter;
  8. use Gedmo\SoftDeleteable\SoftDeleteableListener;
  10. /**
  11.  * The SoftDeleteableFilter adds the condition necessary to
  12.  * filter entities which were deleted "softly"
  13.  *
  14.  * @author Gustavo Falco <comfortablynumb84@gmail.com>
  15.  * @author Gediminas Morkevicius <gediminas.morkevicius@gmail.com>
  16.  * @author Patrik Votoček <patrik@votocek.cz>
  17.  * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
  18.  */
  19. class SoftDeleteableFilter extends SQLFilter
  20. {
  21.     /**
  22.      * @var SoftDeleteableListener
  23.      */
  24.     protected $listener;
  26.     /**
  27.      * @var EntityManagerInterface
  28.      */
  29.     protected $entityManager;
  31.     /**
  32.      * @var string[bool]
  33.      */
  34.     protected $disabled = [];
  36.     /**
  37.      * @param string $targetTableAlias
  38.      *
  39.      * @return string
  40.      */
  41.     public function addFilterConstraint(ClassMetadata $targetEntity, $targetTableAlias)
  42.     {
  43.         $class = $targetEntity->getName();
  44.         if (array_key_exists($class, $this->disabled) && true === $this->disabled[$class]) {
  45.             return '';
  46.         } elseif (array_key_exists($targetEntity->rootEntityName, $this->disabled) && true === $this->disabled[$targetEntity->rootEntityName]) {
  47.             return '';
  48.         }
  50.         $config = $this->getListener()->getConfiguration($this->getEntityManager(), $targetEntity->name);
  52.         if (!isset($config['softDeleteable']) || !$config['softDeleteable']) {
  53.             return '';
  54.         }
  56.         $conn = $this->getEntityManager()->getConnection();
  57.         $platform = $conn->getDatabasePlatform();
  58.         $column = $targetEntity->getQuotedColumnName($config['fieldName'], $platform);
  60.         $addCondSql = $platform->getIsNullExpression($targetTableAlias.'.'.$column);
  61.         if (isset($config['timeAware']) && $config['timeAware']) {
  62.             $addCondSql = "({$addCondSql} OR {$targetTableAlias}.{$column} > {$platform->getCurrentTimestampSQL()})";
  63.         }
  65.         return $addCondSql;
  66.     }
  68.     /**
  69.      * @param string $class
  70.      */
  71.     public function disableForEntity($class)
  72.     {
  73.         $this->disabled[$class] = true;
  74.         // Make sure the hash (@see SQLFilter::__toString()) for this filter will be changed to invalidate the query cache.
  75.         $this->setParameter(sprintf('disabled_%s', $class), true);
  76.     }
  78.     /**
  79.      * @param string $class
  80.      */
  81.     public function enableForEntity($class)
  82.     {
  83.         $this->disabled[$class] = false;
  84.         // Make sure the hash (@see SQLFilter::__toString()) for this filter will be changed to invalidate the query cache.
  85.         $this->setParameter(sprintf('disabled_%s', $class), false);
  86.     }
  88.     /**
  89.      * @return SoftDeleteableListener
  90.      *
  91.      * @throws \RuntimeException
  92.      */
  93.     protected function getListener()
  94.     {
  95.         if (null === $this->listener) {
  96.             $em = $this->getEntityManager();
  97.             $evm = $em->getEventManager();
  99.             foreach ($evm->getListeners() as $listeners) {
  100.                 foreach ($listeners as $listener) {
  101.                     if ($listener instanceof SoftDeleteableListener) {
  102.                         $this->listener = $listener;
  104.                         break 2;
  105.                     }
  106.                 }
  107.             }
  109.             if (null === $this->listener) {
  110.                 throw new \RuntimeException('Listener "SoftDeleteableListener" was not added to the EventManager!');
  111.             }
  112.         }
  114.         return $this->listener;
  115.     }
  117.     /**
  118.      * @return EntityManagerInterface
  119.      */
  120.     protected function getEntityManager()
  121.     {
  122.         if (null === $this->entityManager) {
  123.             $refl = new \ReflectionProperty('Doctrine\ORM\Query\Filter\SQLFilter', 'em');
  124.             $refl->setAccessible(true);
  125.             $this->entityManager = $refl->getValue($this);
  126.         }
  128.         return $this->entityManager;
  129.     }
  130. }