Как получить все переменные из шаблона веточки?
Можно ли получить все переменные внутри шаблона Twig с помощью PHP?
Пример someTemplate.twig.php:
Hello {{ name }},
your new email is {{ email }}
Теперь я хочу сделать что-то вроде этого:
$template = $twig->loadTemplate('someTemplate');
$variables = $template->getVariables();
Переменные $ теперь должны содержать "name" и "email".
Причина, по которой я хочу это сделать, заключается в том, что я работаю в системе CMS, где мои шаблоны ветвей и переменные динамически устанавливаются моими пользователями, и они также заполняют переменные через API.
Я хочу установить значения по умолчанию для неустановленных переменных и, следовательно, мне нужен список всех переменных, которые существуют внутри шаблона...
16 ответов
ОБНОВЛЕНИЕ 2017
Это возможно с помощью {{ dump() }} фильтр. Спасибо за указание на это в комментариях!
устаревший
Это невозможно.
Вы можете найти эти переменные в шаблонах веток и добавить |default('your_value') фильтр к ним. Он проверит, определена ли переменная и не является ли она пустой, а если нет - заменит ее на ваше значение.
Это полезно, чтобы найти все ключи верхнего уровня, доступные в текущем контексте:
<ol>
{% for key, value in _context %}
<li>{{ key }}</li>
{% endfor %}
</ol>
Благодаря https://www.drupal.org/node/1906780
То, как я это делаю
<script>console.log({{ _context | json_encode | raw }});</script>
А потом я просто проверяю свою консоль с помощью DevTools
Ответ добавлен в 2015
В прошлом это было невозможно. Но начиная с версии 1.5 добавлена функция dump(). Таким образом, вы можете получить все переменные из текущего контекста, вызывая dump() без каких-либо параметров:
<pre>
{{ dump(user) }}
</pre>
Однако при создании среды Twig необходимо явно добавить расширение Twig_Extension_Debug, поскольку dump() по умолчанию недоступно:
$twig = new Twig_Environment($loader, array(
'debug' => true,
// ...
));
$twig->addExtension(new Twig_Extension_Debug());
Если вы использовали что-то вроде Symfony, Silex и т. Д., dump() доступно по умолчанию.
РЕДАКТИРОВАТЬ:
Можно также ссылаться на все переменные, передаваемые в шаблон (вне контекста dump()), используя глобальную переменную _context, Это то, что вы искали. Это массив, связывающий все имена переменных с их значениями.
Вы можете найти дополнительную информацию в документации Twig.
Однако для этого конкретного вопроса, вероятно, было бы лучше собрать все эти пользовательские переменные, о которых вы говорите, под одной и той же зонтичной переменной, чтобы их получение не было головной болью. Я был бы массив под названием custom_variables или что угодно.
Вот лучший и самый простой способ сбросить все переменные:
{{ dump () }}
Источник: https://www.drupal.org/docs/8/theming/twig/discovering-and-inspecting-variables-in-twig-templates
Если вам нужны все элементы Twig внутри текста, просто используйте:
preg_match_all('/\{\%\s*(.*)\s*\%\}|\{\{(?!%)\s*((?:[^\s])*)\s*(?<!%)\}\}/i', $text, $matches);
У меня была проблема, когда редактор WSIWYG помещал HTML-теги внутри переменных Twig. Я фильтрую их с помощью:
public function cleanHTML($text)
{
preg_match_all('/\{\%\s*(.*)\s*\%\}|\{\{(?!%)\s*((?:[^\s])*)\s*(?<!%)\}\}/i', $text, $matches);
if (isset($matches[0]) && count($matches[0])) {
foreach ($matches[0] as $match) {
$clean_match = strip_tags($match);
$text = str_replace($match, $clean_match, $text);
}
}
return $text;
}
ОБНОВИТЬ
Используйте это выражение, чтобы найти все {{ }} и {% %}
preg_match_all('/\{\%\s*([^\%\}]*)\s*\%\}|\{\{\s*([^\}\}]*)\s*\}\}/i', $text, $matches);
Я думаю, что ответ 19Gerhard85 довольно хороший, хотя, возможно, потребуется некоторая настройка, потому что он соответствует некоторым пустым строкам для меня. Мне нравится использовать существующие функции, где это возможно, и это подход, в основном использующий функции веток. Вам нужен доступ к среде ветки вашего приложения.
/**
* @param $twigTemplateName
* @return array
*/
public function getRequiredKeys($twigTemplateName)
{
$twig = $this->twig;
$source = $twig->getLoader()->getSource($twigTemplateName);
$tokens = $twig->tokenize($source);
$parsed = $twig->getParser()->parse($tokens);
$collected = [];
$this->collectNodes($parsed, $collected);
return array_keys($collected);
}
И единственная пользовательская часть - это рекурсивная функция для сбора только определенных типов узлов:
/**
* @param \Twig_Node[] $nodes
* @param array $collected
*/
private function collectNodes($nodes, array &$collected)
{
foreach ($nodes as $node) {
$childNodes = $node->getIterator()->getArrayCopy();
if (!empty($childNodes)) {
$this->collectNodes($childNodes, $collected); // recursion
} elseif ($node instanceof \Twig_Node_Expression_Name) {
$name = $node->getAttribute('name');
$collected[$name] = $node; // ensure unique values
}
}
}
После длительного использования ответа Дункана я наконец нашел "правильный" способ вывести все переменные ветки шаблона
{% dump %}
Вот и все. Все переменные, доступные в шаблоне, будут выгружаться и в разделе дампа профилировщика, а не в середине вашего html, как с {{ dump() }}
если вы поместите содержимое dump () в переменную
{% set d = dump() %}
вы получите все переменные, но в html "dump ready", так что было бы больно разбирать его
надеюсь, это поможет
$loader1 = new Twig_Loader_Array([
'blub.html' => '{{ twig.template.code }}',
]);
$twig = new Twig_Environment($loader1);
$tokens = $twig->tokenize($loader1->getSource('blub.html'));
$nodes = $twig->getParser()->parse($tokens);
var_dump($this->getTwigVariableNames($nodes));
function getTwigVariableNames($nodes): array
{
$variables = [];
foreach ($nodes as $node) {
if ($node instanceof \Twig_Node_Expression_Name) {
$name = $node->getAttribute('name');
$variables[$name] = $name;
} elseif ($node instanceof \Twig_Node_Expression_Constant && $nodes instanceof \Twig_Node_Expression_GetAttr) {
$value = $node->getAttribute('value');
if (!empty($value) && is_string($value)) {
$variables[$value] = $value;
}
} elseif ($node instanceof \Twig_Node_Expression_GetAttr) {
$path = implode('.', $this->getTwigVariableNames($node));
if (!empty($path)) {
$variables[$path] = $path;
}
} elseif ($node instanceof \Twig_Node) {
$variables += $this->getTwigVariableNames($node);
}
}
return $variables;
}
повеселись:-)
Вы должны проанализировать шаблон и пройти через AST, который он возвращает:
$loaded = $twig->getLoader()->getSource($template);
var_dump(extractVars($twig->parse($twig->tokenize($loaded)));
function extractVars($node)
{
if (!$node instanceof Traversable) return array();
$vars = array();
foreach ($node as $cur)
{
if (get_class($cur) != 'Twig_Node_Expression_Name')
{
$vars = array_merge($vars, extractVars($cur));
}
else
{
$vars[] = $cur->getAttribute('name');
}
}
return $vars;
}
Я создал класс Twig2Schema для вывода переменных из Twig AST. Чтобы получить переменные в документе, вам нужно рекурсивно "пройти" через Twig AST и иметь правила, когда вы сталкиваетесь с определенными типами языковых узлов.
Этот класс извлекает имена переменных из узлов, если они не всегда определены, а также извлекает переменные из значений, используемых в ForLoopNodes и IfStatements.
Чтобы использовать его, вы можете позвонить infer для всего шаблона или подмножества дерева, используя inferFromAst.
<?php
class Twig2Schema
{
/**
* @param \Twig\Environment $twig - A twig environment containing loaded templates
* @param $twigTemplateName - The name of the template to infer variables from
* @param $config - A configuration object for this function
* @return array
*/
public function infer(\Twig\Environment $twig, $twigTemplateName)
{
$source = $twig->getLoader()->getSourceContext($twigTemplateName);
$tokens = $twig->tokenize($source);
$ast = $twig->parse($tokens);
return $this->inferFromAst($ast);
}
/**
* @param \Twig\Node\ModuleNode $ast - An abstract syntax tree parsed from Twig
* @return array - The variables used in the Twig template
*/
public function inferFromAst(\Twig\Node\ModuleNode $ast)
{
$keys = $this->visit($ast);
foreach ($keys as $key => $value) {
if ($value['always_defined'] || $key === '_self') {
unset($keys[$key]);
}
}
return $keys;
}
/**
* @param \Twig\Node\Node $ast - The tree to traverse and extract variables
* @return array - The variables found in this tree
*/
private function visit(\Twig\Node\Node $ast)
{
$vars = [];
switch (get_class($ast)) {
case \Twig\Node\Expression\AssignNameExpression::class:
case \Twig\Node\Expression\NameExpression::class:
$vars[$ast->getAttribute('name')] = [
'type' => get_class($ast),
'always_defined' => $ast->getAttribute('always_defined'),
'is_defined_test' => $ast->getAttribute('is_defined_test'),
'ignore_strict_check' => $ast->getAttribute('ignore_strict_check')
];
break;
case \Twig\Node\ForNode::class:
foreach ($ast as $key => $node) {
switch ($key) {
case 'value_target':
$vars[$node->getAttribute('name')] = [
'for_loop_target' => true,
'always_defined' => $node->getAttribute('always_defined')
];
break;
case 'body':
$vars = array_merge($vars, $this->visit($node));
break;
default:
break;
}
}
break;
case \Twig\Node\IfNode::class:
foreach ($ast->getNode('tests') as $key => $test) {
$vars = array_merge($vars, $this->visit($test));
}
foreach ($ast->getNode('else') as $key => $else) {
$vars = array_merge($vars, $this->visit($else));
}
break;
default:
if ($ast->count()) {
foreach ($ast as $key => $node) {
$vars = array_merge($vars, $this->visit($node));
}
}
break;
}
return $vars;
}
}
После того, как я потратил целую ночь, пробуя все вышеприведенные ответы, я понял, что по какой-то неожиданной причине регулярные выражения вообще не работали с моими простыми шаблонами. Они вернули нежелательную или частичную информацию. Поэтому я решил удалить все содержимое между тегами вместо подсчета тегов ^_^.
Я имею в виду, если шаблон 'AAA {{BB}} CC {{DD}} {{BB}} SS'Я просто добавляю '}}' в начале шаблона и '{{ в конце концов.... и весь контент между }} а также {{ Я просто раздену, добавив между ними запятую =>}}{{BB,}}{{DD,}}{{BB,}}{{, Тогда - просто сотри }} а также {{,
Мне потребовалось около 15 минут, чтобы написать и протестировать.... но с регулярными выражениями я провел около 5 часов без успеха.
/**
* deletes ALL the string contents between all the designated characters
* @param $start - pattern start
* @param $end - pattern end
* @param $string - input string,
* @return mixed - string
*/
function auxDeleteAllBetween($start, $end, $string) {
// it helps to assembte comma dilimited strings
$string = strtr($start. $string . $end, array($start => ','.$start, $end => chr(2)));
$startPos = 0;
$endPos = strlen($string);
while( $startPos !== false && $endPos !== false){
$startPos = strpos($string, $start);
$endPos = strpos($string, $end);
if ($startPos === false || $endPos === false) {
return $string;
}
$textToDelete = substr($string, $startPos, ($endPos + strlen($end)) - $startPos);
$string = str_replace($textToDelete, '', $string);
}
return $string;
}
/**
* This function is intended to replace
* //preg_match_all('/\{\%\s*([^\%\}]*)\s*\%\}|\{\{\s*([^\}\}]*)\s*\}\}/i',
* which did not give intended results for some reason.
*
* @param $inputTpl
* @return array
*/
private function auxGetAllTags($inputTpl){
$inputTpl = strtr($inputTpl, array('}}' => ','.chr(1), '{{' => chr(2)));
return explode(',',$this->auxDeleteAllBetween(chr(1),chr(2),$inputTpl));
}
$template = '<style>
td{border-bottom:1px solid #eee;}</style>
<p>Dear {{jedi}},<br>New {{padawan}} is waiting for your approval: </p>
<table border="0">
<tbody><tr><td><strong>Register as</strong></td><td>{{register_as}}, user-{{level}}</td></tr>
<tr><td><strong>Name</strong></td><td>{{first_name}} {{last_name}}</td></tr>...';
print_r($this->auxGetAllTags($template));
Надеюсь, это кому-нибудь поможет:)
Есть актуальное решение для Twig 3.0:
function visit(\Twig\Node\Node $node, &$variables)
{
// @see https://github.com/twigphp/Twig/issues/2340 for details about NodeCaptureInterface
if ($node instanceof \Twig\Node\NodeCaptureInterface) {
return;
}
if ($node instanceof \Twig\Node\Expression\NameExpression
&& false === $node->getAttribute('always_defined') // ignore scoped names as (key, value) in for loop
) {
$variables[$node->getAttribute('name')] = null;
return;
}
foreach ($node as $child) {
visit($child, $variables);
}
}
// @var Twig\Environment $twig
// create template from string
$template = 'my template {{ var }}';
$source = new \Twig\Source($template, 'template');
// or get from loader
// $source = $twig->getLoader()->getSourceContext('template.twig.html');
// tokenize and par
$tokens = $twig->tokenize($source);
$nodes = $twig->parse($tokens);
$variables = [];
visit($nodes, $variables);
var_dump(array_keys($variables));
Если вы посмотрите на процесс компиляции twig, вы увидите, что есть параметр с именем ignore_strict_check, если он истинный, компиляция заменит пропущенные переменные на null, но если false компиляция выдаст ошибку времени выполнения, посмотрите на строку файла twig / src/Node/Expression/NameExpression.php 63 в symfony вы можете установить этот параметр через конфигурации пакета twig strict_variables: false
Создайте Twig_Extension и добавьте функцию с флагом needs_context:
class MyTwigExtension extends Twig_Extension{
public function getFunctions()
{
return array(
new \Twig_SimpleFunction('myTwigFunction', array($this, 'myTwigFunction'), array('needs_context' => true)),
);
}
public function myTwigFunction($context)
{
var_dump($context);
return '';
}
}
Контекст будет передан в качестве первого параметра вашей функции, содержащей все переменные.
В вашем шаблоне Twig вам просто нужно вызвать эту функцию:
{{myTwigFunction()}}
Если вам нужна помощь в создании расширения Twig, обратитесь к этой документации:
Этот вопрос имеет дубликат - там я нашел полезный и более мощный RegEX, чем выше. Этот, я улучшил, чтобы соответствовать более точному:
\{\{(?!%)\s* # Starts with {{ not followed by % followed by 0 or more spaces
((?:(?!\.)[^\s])*?) # Match anything without a point or space in it
(\|(?:(?!\.)[^\s])*)? # Match filter within variable
\s*(?<!%)\}\} # Ends with 0 or more spaces not followed by % ending with }}
| # Or
\{%\s* # Starts with {% followed by 0 or more spaces
(?:\s(?!endfor)|(endif)|(else)(\w+))+ # Match the last word which can not be endfor, endif or else
\s*%\} # Ends with 0 or more spaces followed by %}
# Flags: i: case insensitive matching | x: Turn on free-spacing mode to ignore whitespace between regex tokens, and allow # comments.