vendor/symfony/expression-language/ExpressionFunction.php line 73

  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. /**
  15.  * Represents a function that can be used in an expression.
  16.  *
  17.  * A function is defined by two PHP callables. The callables are used
  18.  * by the language to compile and/or evaluate the function.
  19.  *
  20.  * The "compiler" function is used at compilation time and must return a
  21.  * PHP representation of the function call (it receives the function
  22.  * arguments as arguments).
  23.  *
  24.  * The "evaluator" function is used for expression evaluation and must return
  25.  * the value of the function call based on the values defined for the
  26.  * expression (it receives the values as a first argument and the function
  27.  * arguments as remaining arguments).
  28.  *
  29.  * @author Fabien Potencier <fabien@symfony.com>
  30.  */
  31. class ExpressionFunction
  32. {
  33.     private string $name;
  34.     private \Closure $compiler;
  35.     private \Closure $evaluator;
  37.     /**
  38.      * @param string   $name      The function name
  39.      * @param callable $compiler  A callable able to compile the function
  40.      * @param callable $evaluator A callable able to evaluate the function
  41.      */
  42.     public function __construct(string $name, callable $compiler, callable $evaluator)
  43.     {
  44.         $this->name = $name;
  45.         $this->compiler = $compiler(...);
  46.         $this->evaluator = $evaluator(...);
  47.     }
  49.     public function getName(): string
  50.     {
  51.         return $this->name;
  52.     }
  54.     public function getCompiler(): \Closure
  55.     {
  56.         return $this->compiler;
  57.     }
  59.     public function getEvaluator(): \Closure
  60.     {
  61.         return $this->evaluator;
  62.     }
  64.     /**
  65.      * Creates an ExpressionFunction from a PHP function name.
  66.      *
  67.      * @param string|null $expressionFunctionName The expression function name (default: same than the PHP function name)
  68.      *
  69.      * @throws \InvalidArgumentException if given PHP function name does not exist
  70.      * @throws \InvalidArgumentException if given PHP function name is in namespace
  71.      *                                   and expression function name is not defined
  72.      */
  73.     public static function fromPhp(string $phpFunctionName, string $expressionFunctionName = null): self
  74.     {
  75.         $phpFunctionName = ltrim($phpFunctionName, '\\');
  76.         if (!\function_exists($phpFunctionName)) {
  77.             throw new \InvalidArgumentException(sprintf('PHP function "%s" does not exist.', $phpFunctionName));
  78.         }
  80.         $parts = explode('\\', $phpFunctionName);
  81.         if (!$expressionFunctionName && \count($parts) > 1) {
  82.             throw new \InvalidArgumentException(sprintf('An expression function name must be defined when PHP function "%s" is namespaced.', $phpFunctionName));
  83.         }
  85.         $compiler = function (...$args) use ($phpFunctionName) {
  86.             return sprintf('\%s(%s)', $phpFunctionName, implode(', ', $args));
  87.         };
  89.         $evaluator = function ($p, ...$args) use ($phpFunctionName) {
  90.             return $phpFunctionName(...$args);
  91.         };
  93.         return new self($expressionFunctionName ?: end($parts), $compiler, $evaluator);
  94.     }
  95. }