vendor/symfony/expression-language/ExpressionLanguage.php line 64

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\ExpressionLanguage;
  14. use Psr\Cache\CacheItemPoolInterface;
  15. use Symfony\Component\Cache\Adapter\ArrayAdapter;
  17. /**
  18.  * Allows to compile and evaluate expressions written in your own DSL.
  19.  *
  20.  * @author Fabien Potencier <fabien@symfony.com>
  21.  */
  22. class ExpressionLanguage
  23. {
  24.     private $cache;
  25.     private $lexer;
  26.     private $parser;
  27.     private $compiler;
  29.     protected $functions = [];
  31.     /**
  32.      * @param ExpressionFunctionProviderInterface[] $providers
  33.      */
  34.     public function __construct(CacheItemPoolInterface $cache = null, array $providers = [])
  35.     {
  36.         $this->cache = $cache ?: new ArrayAdapter();
  37.         $this->registerFunctions();
  38.         foreach ($providers as $provider) {
  39.             $this->registerProvider($provider);
  40.         }
  41.     }
  43.     /**
  44.      * Compiles an expression source code.
  45.      *
  46.      * @param Expression|string $expression The expression to compile
  47.      * @param array             $names      An array of valid names
  48.      *
  49.      * @return string The compiled PHP source code
  50.      */
  51.     public function compile($expression, $names = [])
  52.     {
  53.         return $this->getCompiler()->compile($this->parse($expression, $names)->getNodes())->getSource();
  54.     }
  56.     /**
  57.      * Evaluate an expression.
  58.      *
  59.      * @param Expression|string $expression The expression to compile
  60.      * @param array             $values     An array of values
  61.      *
  62.      * @return mixed The result of the evaluation of the expression
  63.      */
  64.     public function evaluate($expression, $values = [])
  65.     {
  66.         return $this->parse($expression, array_keys($values))->getNodes()->evaluate($this->functions, $values);
  67.     }
  69.     /**
  70.      * Parses an expression.
  71.      *
  72.      * @param Expression|string $expression The expression to parse
  73.      * @param array             $names      An array of valid names
  74.      *
  75.      * @return ParsedExpression A ParsedExpression instance
  76.      */
  77.     public function parse($expression, $names)
  78.     {
  79.         if ($expression instanceof ParsedExpression) {
  80.             return $expression;
  81.         }
  83.         asort($names);
  84.         $cacheKeyItems = [];
  86.         foreach ($names as $nameKey => $name) {
  87.             $cacheKeyItems[] = \is_int($nameKey) ? $name : $nameKey.':'.$name;
  88.         }
  90.         $cacheItem = $this->cache->getItem(rawurlencode($expression.'//'.implode('|', $cacheKeyItems)));
  92.         if (null === $parsedExpression = $cacheItem->get()) {
  93.             $nodes = $this->getParser()->parse($this->getLexer()->tokenize((string) $expression), $names);
  94.             $parsedExpression = new ParsedExpression((string) $expression, $nodes);
  96.             $cacheItem->set($parsedExpression);
  97.             $this->cache->save($cacheItem);
  98.         }
  100.         return $parsedExpression;
  101.     }
  103.     /**
  104.      * Registers a function.
  105.      *
  106.      * @param string   $name      The function name
  107.      * @param callable $compiler  A callable able to compile the function
  108.      * @param callable $evaluator A callable able to evaluate the function
  109.      *
  110.      * @throws \LogicException when registering a function after calling evaluate(), compile() or parse()
  111.      *
  112.      * @see ExpressionFunction
  113.      */
  114.     public function register($name, callable $compiler, callable $evaluator)
  115.     {
  116.         if (null !== $this->parser) {
  117.             throw new \LogicException('Registering functions after calling evaluate(), compile() or parse() is not supported.');
  118.         }
  120.         $this->functions[$name] = ['compiler' => $compiler, 'evaluator' => $evaluator];
  121.     }
  123.     public function addFunction(ExpressionFunction $function)
  124.     {
  125.         $this->register($function->getName(), $function->getCompiler(), $function->getEvaluator());
  126.     }
  128.     public function registerProvider(ExpressionFunctionProviderInterface $provider)
  129.     {
  130.         foreach ($provider->getFunctions() as $function) {
  131.             $this->addFunction($function);
  132.         }
  133.     }
  135.     protected function registerFunctions()
  136.     {
  137.         $this->addFunction(ExpressionFunction::fromPhp('constant'));
  138.     }
  140.     private function getLexer(): Lexer
  141.     {
  142.         if (null === $this->lexer) {
  143.             $this->lexer = new Lexer();
  144.         }
  146.         return $this->lexer;
  147.     }
  149.     private function getParser(): Parser
  150.     {
  151.         if (null === $this->parser) {
  152.             $this->parser = new Parser($this->functions);
  153.         }
  155.         return $this->parser;
  156.     }
  158.     private function getCompiler(): Compiler
  159.     {
  160.         if (null === $this->compiler) {
  161.             $this->compiler = new Compiler($this->functions);
  162.         }
  164.         return $this->compiler->reset();
  165.     }
  166. }