vendor/happyr/doctrine-specification/src/Logic/LogicX.php line 96

Open in your IDE?
  1. <?php
  2. declare(strict_types=1);
  4. /**
  5.  * This file is part of the Happyr Doctrine Specification package.
  6.  *
  7.  * (c) Tobias Nyholm <tobias@happyr.com>
  8.  *     Kacper Gunia <kacper@gunia.me>
  9.  *     Peter Gribanov <info@peter-gribanov.ru>
  10.  *
  11.  * For the full copyright and license information, please view the LICENSE
  12.  * file that was distributed with this source code.
  13.  */
  15. namespace Happyr\DoctrineSpecification\Logic;
  17. use Doctrine\ORM\QueryBuilder;
  18. use Happyr\DoctrineSpecification\Filter\Filter;
  19. use Happyr\DoctrineSpecification\Filter\Satisfiable;
  20. use Happyr\DoctrineSpecification\Query\QueryModifier;
  21. use Happyr\DoctrineSpecification\Specification\Specification;
  23. /**
  24.  * This class should be used when you combine two or more Expressions.
  25.  */
  26. abstract class LogicX implements Specification
  27. {
  28.     public const AND_X = 'andX';
  30.     public const OR_X = 'orX';
  32.     /**
  33.      * @var string
  34.      */
  35.     private $expression;
  37.     /**
  38.      * @var Filter[]|QueryModifier[]
  39.      */
  40.     private $children;
  42.     /**
  43.      * Take two or more Expression as parameters.
  44.      *
  45.      * @param string               $expression
  46.      * @param Filter|QueryModifier ...$children
  47.      */
  48.     public function __construct(string $expression, ...$children)
  49.     {
  50.         $this->expression = $expression;
  51.         $this->children = $children;
  52.     }
  54.     /**
  55.      * @param QueryBuilder $qb
  56.      * @param string       $context
  57.      *
  58.      * @return string
  59.      */
  60.     public function getFilter(QueryBuilder $qb, string $context): string
  61.     {
  62.         $children = [];
  63.         foreach ($this->children as $spec) {
  64.             if ($spec instanceof Filter) {
  65.                 $filter = $spec->getFilter($qb, $context);
  67.                 if ($filter) {
  68.                     $children[] = $filter;
  69.                 }
  70.             }
  71.         }
  73.         if (!$children) {
  74.             return '';
  75.         }
  77.         $expression = [$qb->expr(), $this->expression];
  79.         if (!is_callable($expression)) {
  80.             throw new \InvalidArgumentException(
  81.                 sprintf('Undefined "%s" method in "%s" class.', $this->expression, get_class($qb->expr()))
  82.             );
  83.         }
  85.         return (string) call_user_func_array($expression, $children);
  86.     }
  88.     /**
  89.      * @param QueryBuilder $qb
  90.      * @param string       $context
  91.      */
  92.     public function modify(QueryBuilder $qb, string $context): void
  93.     {
  94.         foreach ($this->children as $child) {
  95.             if ($child instanceof QueryModifier) {
  96.                 $child->modify($qb, $context);
  97.             }
  98.         }
  99.     }
  101.     /**
  102.      * {@inheritdoc}
  103.      */
  104.     public function filterCollection(iterable $collection, ?string $context = null): iterable
  105.     {
  106.         foreach ($collection as $candidate) {
  107.             if ($this->isSatisfiedBy($candidate, $context)) {
  108.                 yield $candidate;
  109.             }
  110.         }
  111.     }
  113.     /**
  114.      * {@inheritdoc}
  115.      */
  116.     public function isSatisfiedBy($candidate, ?string $context = null): bool
  117.     {
  118.         $has_satisfiable_children = false;
  120.         foreach ($this->children as $child) {
  121.             if (!$child instanceof Satisfiable) {
  122.                 continue;
  123.             }
  125.             $has_satisfiable_children = true;
  127.             $satisfied = $child->isSatisfiedBy($candidate, $context);
  129.             if ($satisfied && self::OR_X === $this->expression) {
  130.                 return true;
  131.             }
  133.             if (!$satisfied && self::AND_X === $this->expression) {
  134.                 return false;
  135.             }
  136.         }
  138.         return !$has_satisfiable_children || self::AND_X === $this->expression;
  139.     }
  141.     /**
  142.      * Add another child to this logic tree.
  143.      *
  144.      * @param Filter|QueryModifier $child
  145.      */
  146.     protected function append($child): void
  147.     {
  148.         $this->children[] = $child;
  149.     }
  150. }