vendor/pimcore/pimcore/lib/Targeting/ConditionMatcher.php line 118

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /**
  6.  * Pimcore
  7.  *
  8.  * This source file is available under two different licenses:
  9.  * - GNU General Public License version 3 (GPLv3)
  10.  * - Pimcore Commercial License (PCL)
  11.  * Full copyright and license information is available in
  12.  * LICENSE.md which is distributed with this source code.
  13.  *
  14.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  15.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  16.  */
  18. namespace Pimcore\Targeting;
  20. use Pimcore\Targeting\Condition\ConditionInterface;
  21. use Pimcore\Targeting\Condition\EventDispatchingConditionInterface;
  22. use Pimcore\Targeting\Condition\VariableConditionInterface;
  23. use Pimcore\Targeting\ConditionMatcher\ExpressionBuilder;
  24. use Pimcore\Targeting\Model\VisitorInfo;
  25. use Psr\Log\LoggerInterface;
  26. use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
  27. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  29. class ConditionMatcher implements ConditionMatcherInterface
  30. {
  31.     /**
  32.      * @var ConditionFactoryInterface
  33.      */
  34.     private $conditionFactory;
  36.     /**
  37.      * @var DataLoaderInterface
  38.      */
  39.     private $dataLoader;
  41.     /**
  42.      * @var EventDispatcherInterface
  43.      */
  44.     private $eventDispatcher;
  46.     /**
  47.      * @var ExpressionLanguage
  48.      */
  49.     private $expressionLanguage;
  51.     /**
  52.      * @var LoggerInterface
  53.      */
  54.     private $logger;
  56.     /**
  57.      * @var array
  58.      */
  59.     private $collectedVariables = [];
  61.     public function __construct(
  62.         ConditionFactoryInterface $conditionFactory,
  63.         DataLoaderInterface $dataLoader,
  64.         EventDispatcherInterface $eventDispatcher,
  65.         ExpressionLanguage $expressionLanguage,
  66.         LoggerInterface $logger
  67.     ) {
  68.         $this->conditionFactory = $conditionFactory;
  69.         $this->dataLoader = $dataLoader;
  70.         $this->eventDispatcher = $eventDispatcher;
  71.         $this->expressionLanguage = $expressionLanguage;
  72.         $this->logger = $logger;
  73.     }
  75.     /**
  76.      * {@inheritdoc}
  77.      */
  78.     public function match(VisitorInfo $visitorInfo, array $conditions, bool $collectVariables = false): bool
  79.     {
  80.         // reset internal state
  81.         $this->collectedVariables = [];
  83.         $count = count($conditions);
  84.         if (0 === $count) {
  85.             // no conditions -> rule matches
  86.             return true;
  87.         } elseif (1 === $count) {
  88.             // no need to build up expression if there's only one condition
  89.             return $this->matchCondition($visitorInfo, $conditions[0], $collectVariables);
  90.         }
  92.         $expressionBuilder = new ExpressionBuilder();
  94.         foreach ($conditions as $conditionConfig) {
  95.             $conditionResult = $this->matchCondition($visitorInfo, $conditionConfig, $collectVariables);
  97.             $expressionBuilder->addCondition($conditionConfig, $conditionResult);
  98.         }
  100.         $expression = $expressionBuilder->getExpression();
  101.         $values = $expressionBuilder->getValues();
  102.         $result = $this->expressionLanguage->evaluate($expression, $values);
  104.         return (bool)$result;
  105.     }
  107.     /**
  108.      * {@inheritdoc}
  109.      */
  110.     public function getCollectedVariables(): array
  111.     {
  112.         return $this->collectedVariables;
  113.     }
  115.     private function matchCondition(VisitorInfo $visitorInfo, array $config, bool $collectVariables = false): bool
  116.     {
  117.         try {
  118.             $condition = $this->conditionFactory->build($config);
  119.         } catch (\Throwable $e) {
  120.             $this->logger->error((string) $e);
  122.             return false;
  123.         }
  125.         // check prerequisites - e.g. a condition without a value
  126.         // (= all values match) does not need to fetch provider data
  127.         // as location or browser
  128.         if (!$condition->canMatch()) {
  129.             return false;
  130.         }
  132.         if ($condition instanceof DataProviderDependentInterface) {
  133.             $this->dataLoader->loadDataFromProviders($visitorInfo, $condition->getDataProviderKeys());
  134.         }
  136.         if ($condition instanceof EventDispatchingConditionInterface) {
  137.             $condition->preMatch($visitorInfo, $this->eventDispatcher);
  138.         }
  140.         try {
  141.             $result = $condition->match($visitorInfo);
  142.         } catch (\Throwable $e) {
  143.             $this->logger->error((string) $e);
  145.             return false;
  146.         }
  148.         if ($collectVariables) {
  149.             $this->collectConditionVariables($config, $condition);
  150.         }
  152.         if ($condition instanceof EventDispatchingConditionInterface) {
  153.             $condition->postMatch($visitorInfo, $this->eventDispatcher);
  154.         }
  156.         return $result;
  157.     }
  159.     private function collectConditionVariables(array $config, ConditionInterface $condition)
  160.     {
  161.         $data = [
  162.             'type' => $config['type'],
  163.         ];
  165.         if ($condition instanceof VariableConditionInterface) {
  166.             $variables = $condition->getMatchedVariables();
  168.             if (!empty($variables)) {
  169.                 $data['data'] = $variables;
  170.             }
  171.         }
  173.         $this->collectedVariables[] = $data;
  174.     }
  175. }