WARNING: You are browsing the documentation for Symfony 3.4 which is not maintained anymore. Consider upgrading your projects to Symfony 5.2.

Caching Expressions Using Parser Caches

3.4 version

Maintained

4.4 5.1 5.2 current 5.3 dev

Unmaintained

2.4 2.5 2.6 2.7 2.8 3.0 3.1 3.2 3.3 3.4 4.0 4.1 4.2 4.3 5.0

Caching Expressions Using Parser Caches
- The Workflow
- Using Parsed and Serialized Expressions

Caching Expressions Using Parser Caches¶

The ExpressionLanguage component already provides a compile() method to be able to cache the expressions in plain PHP. But internally, the component also caches the parsed expressions, so duplicated expressions can be compiled/evaluated quicker.

The Workflow¶

Both evaluate() and compile() need to do some things before each can provide the return values. For evaluate(), this overhead is even bigger.

Both methods need to tokenize and parse the expression. This is done by the parse() method. It returns a Symfony\Component\ExpressionLanguage\ParsedExpression. Now, the compile() method just returns the string conversion of this object. The evaluate() method needs to loop through the “nodes” (pieces of an expression saved in the ParsedExpression) and evaluate them on the fly.

To save time, the ExpressionLanguage caches the ParsedExpression so it can skip the tokenize and parse steps with duplicate expressions. The caching is done by a PSR-6 CacheItemPoolInterface instance (by default, it uses an Symfony\Component\Cache\Adapter\ArrayAdapter). You can customize this by creating a custom cache pool or using one of the available ones and injecting this using the constructor:

use Symfony\Component\Cache\Adapter\RedisAdapter;
use Symfony\Component\ExpressionLanguage\ExpressionLanguage;

$cache = new RedisAdapter(...);
$expressionLanguage = new ExpressionLanguage($cache);

New in version 3.2: PSR-6 caching support was introduced in Symfony 3.2. Prior to version 3.2, a Symfony\Component\ExpressionLanguage\ParserCache\ParserCacheInterface instance had to be injected.

Using Parsed and Serialized Expressions¶

Both evaluate() and compile() can handle ParsedExpression and SerializedParsedExpression:

// ...

// the parse() method returns a ParsedExpression
$expression = $expressionLanguage->parse('1 + 4', []);

var_dump($expressionLanguage->evaluate($expression)); // prints 5

use Symfony\Component\ExpressionLanguage\SerializedParsedExpression;
// ...

$expression = new SerializedParsedExpression(
    '1 + 4',
    serialize($expressionLanguage->parse('1 + 4', [])->getNodes())
);

var_dump($expressionLanguage->evaluate($expression)); // prints 5

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.