Оператор коалесценции нуля

Парсинг и линтинг выражений

Компонент ExpressionLanguage предоставляет способ парсинга и линтинга выражений.
Метод parse() возвращает экземпляр ParsedExpression, который может быть использован для проверки и манипулирования выражением.
lint(), с другой стороны, возвращает булево число, указывающее, является ли выражение валидным или нет:

1
2
3
4
5
6
7
8
9

use Symfony\Component\ExpressionLanguage\ExpressionLanguage;

$expressionLanguage = new ExpressionLanguage();

var_dump($expressionLanguage->parse('1 + 2'));
// отображает AST узлы выражения, которые можно
// исследовать и манипулировать

var_dump($expressionLanguage->lint('1 + 2')); // displays true

Поведение этих методов можно сконфигурировать с помощью некоторых флажков, определенных в классе Parser:

• IGNORE_UNKNOWN_VARIABLES: не вызывать исключение, если переменная не определена в выражении;
• IGNORE_UNKNOWN_FUNCTIONS: не вызывать исключение, если функция не определена в выражении;

Вот, как вы можете использовать эти флажки:

1
2
3
4
5
6
7

use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
use Symfony\Component\ExpressionLanguage\Parser;

$expressionLanguage = new ExpressionLanguage();

// это возвращает true, так как неизвестные переменные и функции игнорируются
var_dump($expressionLanguage->lint('unknown_var + unknown_function()', Parser::IGNORE_UNKNOWN_VARIABLES | Parser::IGNORE_UNKNOWN_FUNCTIONS));

Рабочий процесс

Как evaluate(),
так и compile() должны выполнить некоторые действия, прежде чем каждый из них сможет предоставить возвратные значения. Для evaluate() эта дополнительная нагрузка еще больше.

Оба метода должны выполнить токенизацию и разбор выражения. Это делается с помощью метода parse(). Он возвращает ParsedExpression. Теперь метод compile() просто возвращает строковое преобразование этого объекта. Метод evaluate() должен пройтись по "узлам" (фрагментам выражения, сохраненным в ParsedExpression) и оценить их на лету.

Для экономии времени ExpressionLanguage кеширует ParsedExpression, чтобы можно было пропустить этапы токенизации и разбора дублирующихся выражений. Кеширование осуществляется экземпляром PSR-6 CacheItemPoolInterface (по умолчанию используется ArrayAdapter). Вы можете настроить это, создав пользовательский пул кеша или использовать один из имеющихся и внедрить его с помощью конструктора:

1
2
3
4
5

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

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

Использование разобранных и сериализованных выражений

Как evaluate(), так и compile() могут обработать ParsedExpression и SerializedParsedExpression:

1
2
3
4
5
6

// ...

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

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

1
2
3
4
5
6
7
8
9

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

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

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

Сброс АСД

Вызовите метод getNodes() после разбора любого выражения, чтобы получить его АСД:

1
2
3
4
5
6
7
8
9
10
11
12

use Symfony\Component\ExpressionLanguage\ExpressionLanguage;

$ast = (new ExpressionLanguage())
    ->parse('1 + 2', [])
    ->getNodes()
;

// сбросить узлы АСД для проверки
var_dump($ast);

// сбросить узлы АСД как представление строки
$astAsString = $ast->dump();

Манипуляции с АСД

Узлы АСД также могут быть сброшены в массив узлов PHP, что позволяет манипулировать ими. Вызовите toArray() для преобразования АСД в массив:

// ...

$astAsArray = (new ExpressionLanguage())

->parse('1 + 2', []) ->getNodes() ->toArray()

;

Регистрация функций

Функции регистрируются на каждом конкретном экземпляре ExpressionLanguage. Это означает, что функции могут быть использованы в любом выражении, выполняемом этим экземпляром.

Чтобы зарегистрировать функцию, используйте register(). Этот метод имеет 3 аргумента:

• name - Имя функции в выражении;
• compiler - Функция, выполненная при компиляции виражения с использованием функции;
• evaluator - Функция, выполненная при оценке выражения.

Пример:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

use Symfony\Component\ExpressionLanguage\ExpressionLanguage;

$expressionLanguage = new ExpressionLanguage();
$expressionLanguage->register('lowercase', function ($str): string {
    return sprintf('(is_string(%1$s) ? strtolower(%1$s) : %1$s)', $str);
}, function ($arguments, $str): string {
    if (!is_string($str)) {
        return $str;
    }

    return strtolower($str);
});

var_dump($expressionLanguage->evaluate('lowercase("HELLO")'));
// Это выведет: hello

В дополнение к пользовательским аргументам функции, evaluator передается передается переменная arguments в качестве первого аргумента, что равняется второму аргументу функции evaluate() (например, "значения" при оценке выражения).

Использование поставщиков выражений

При использовании класса ExpressionLanguage в своей библиотеке часто возникает желание добавить пользовательские функции. Для этого можно создать новый поставщик выражений путем создания класса, реализующего ExpressionFunctionProviderInterface.

Этот интерфейс требует одного метода: getFunctions(), который возвращает массив функций выражения (экземпляры ExpressionFunction) для регистрации:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

use Symfony\Component\ExpressionLanguage\ExpressionFunction;
use Symfony\Component\ExpressionLanguage\ExpressionFunctionProviderInterface;

class StringExpressionLanguageProvider implements ExpressionFunctionProviderInterface
{
    public function getFunctions(): array
    {
        return [
            new ExpressionFunction('lowercase', function ($str): string {
                return sprintf('(is_string(%1$s) ? strtolower(%1$s) : %1$s)', $str);
            }, function ($arguments, $str): string {
                if (!is_string($str)) {
                    return $str;
                }

                return strtolower($str);
            }),
        ];
    }
}

1

ExpressionFunction::fromPhp('strtoupper');

1

ExpressionFunction::fromPhp('My\strtoupper', 'my_strtoupper');

Вы можете зарегистрировать поставщиков с помощью registerProvider() или с помощью второго аргумента конструктора:

1
2
3
4
5
6
7
8
9
10

use Symfony\Component\ExpressionLanguage\ExpressionLanguage;

// используя конструктор
$expressionLanguage = new ExpressionLanguage(null, [
    new StringExpressionLanguageProvider(),
    // ...
]);

// используя registerProvider()
$expressionLanguage->registerProvider(new StringExpressionLanguageProvider());

1
2
3
4
5
6
7
8
9
10
11
12
13

use Psr\Cache\CacheItemPoolInterface;
use Symfony\Component\ExpressionLanguage\ExpressionLanguage as BaseExpressionLanguage;

class ExpressionLanguage extends BaseExpressionLanguage
{
    public function __construct(CacheItemPoolInterface $cache = null, array $providers = [])
    {
        // добавляет провайдер по умолчанию, чтобы пользователи могли его переопределить
        array_unshift($providers, new StringExpressionLanguageProvider());

        parent::__construct($cache, $providers);
    }
}