Classes List

Symfony\Component\ExpressionLanguage\ExpressionFunction

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


namespace Symfony\Component\ExpressionLanguage;

/** * Represents a function that can be used in an expression. * * A function is defined by two PHP callables. The callables are used * by the language to compile and/or evaluate the function. * * The "compiler" function is used at compilation time and must return a * PHP representation of the function call (it receives the function * arguments as arguments). * * The "evaluator" function is used for expression evaluation and must return * the value of the function call based on the values defined for the * expression (it receives the values as a first argument and the function * arguments as remaining arguments). * * @author Fabien Potencier <fabien@symfony.com> */
class ExpressionFunction
{
    private $name;
    private $compiler;
    private $evaluator;

    /** * @param string $name The function name * @param callable $compiler A callable able to compile the function * @param callable $evaluator A callable able to evaluate the function */
    public function __construct($namecallable $compilercallable $evaluator)
    {
        $this->name = $name;
        $this->compiler = $compiler;
        $this->evaluator = $evaluator;
    }

    public function getName()
    {
        return $this->name;
    }

    public function getCompiler()
    {
        return $this->compiler;
    }

    public function getEvaluator()
    {
        return $this->evaluator;
    }

    /** * Creates an ExpressionFunction from a PHP function name. * * @param string $phpFunctionName The PHP function name * @param string|null $expressionFunctionName The expression function name (default: same than the PHP function name) * * @return self * * @throws \InvalidArgumentException if given PHP function name does not exist * @throws \InvalidArgumentException if given PHP function name is in namespace * and expression function name is not defined */
    public static function fromPhp($phpFunctionName$expressionFunctionName = null)
    {
        $phpFunctionName = ltrim($phpFunctionName'\\');
        if (!function_exists($phpFunctionName)) {
            throw new \InvalidArgumentException(sprintf('PHP function "%s" does not exist.'$phpFunctionName));
        }

        $parts = explode('\\'$phpFunctionName);
        if (!$expressionFunctionName && count($parts) > 1) {
            throw new \InvalidArgumentException(sprintf('An expression function name must be defined when PHP function "%s" is namespaced.'$phpFunctionName));
        }

        $compiler = function () use ($phpFunctionName) {
            return sprintf('\%s(%s)'$phpFunctionNameimplode(', 'func_get_args()));
        };

        $evaluator = function () use ($phpFunctionName) {
            $args = func_get_args();

            return call_user_func_array($phpFunctionNamearray_splice($args1));
        };

        return new self($expressionFunctionName ?: end($parts), $compiler$evaluator);
    }
}