是否可以使用PHP检索Twig模板中的所有变量?
示例someTemplate.twig.php:
Hello {{ name }},
your new email is {{ email }}
现在我想做这样的事情:
$template = $twig->loadTemplate('someTemplate');
$variables = $template->getVariables();
$ variables现在应该包含“name”和“email”。
我想这样做的原因是我正在使用CMS系统,我的用户动态设置我的枝条模板和变量,他们也通过API填充变量。
我想将默认值设置为未设置变量,因此我需要一个模板中存在的所有变量的列表...
2017年更新
可以使用{{ dump() }}
过滤器。感谢您在评论中指出这一点!
过时的
这不可能。
您可以在树枝模板中查找这些变量,并为它们添加|default('your_value')
过滤器。它将检查变量是否已定义且不为空,如果不是 - 将用您的值替换它。
你必须解析模板,然后遍历它返回的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, call_user_func(__FUNCTION__, $cur));
}
else if ($cur->getAttribute('always_defined') == false)
{
// List only predefined variables expected by template,
// filtering out `v` and leaving `arr` from `{% for v in arr%}`
$vars[] = $cur->getAttribute('name');
}
}
return $vars;
}
在我花了一个晚上,尝试了上述所有答案之后,我意识到,出于某些意想不到的原因,正则表达式根本不适用于我的简单模板。他们返回了垃圾或部分信息。所以我决定通过擦除标签之间的所有内容而不是计算标签^ _ ^。
我的意思是,如果一个模板是'AAA {{BB}} CC {{DD}} {{BB}} SS'
,我只是在模板的开头添加'}}'
,最后添加'{{
....以及}}
和{{
之间的所有内容我将剥离,在...之间添加逗号=> }}{{BB,}}{{DD,}}{{BB,}}{{
。然后 - 只需擦除}}
和{{
。
我花了大约15分钟来编写和测试....但是在regexps中我花了大约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_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扩展时需要帮助,请参阅此文档:
这个问题有qazxsw poi - 在那里我发现了一个有用的,比上面更强大的RegEX。这个,我已经改进,以更精确地匹配:
a douplicate
这对我在当前上下文中获取所有顶级键很有用:
<ol>
{% for key, value in _context %}
<li>{{ key }}</li>
{% endfor %}
</ol>
在过去,这是不可能的。但自从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
的上下文之外)。这就是你要找的东西。它是一个将所有变量名称与其值相关联的数组。
You can find some additional info in the Twig documentation.
但是对于这个特定的问题,最好在同一个伞形变量下收集你所说的所有这些自定义变量,这样检索它们就不会让人头痛。我将是一个名为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);
我遇到了一个问题,即WYSIWYG编辑器在Twig变量中放置了HTML标记。我过滤它们:
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;
}
UPDATE
使用此表达式查找所有{{}}和{%%}
preg_match_all('/\{\%\s*([^\%\}]*)\s*\%\}|\{\{\s*([^\}\}]*)\s*\}\}/i', $text, $matches);
我这样做的方式是
<script>console.log({{ _context | json_encode | raw }});</script>
然后我只使用DevTools检查我的控制台
在使用duncan的答案很长一段时间后,我终于找到了“正确”的方法来转储模板的所有树枝变量:
{% dump %}
而已。模板中可用的所有变量都将被转储到探查器的转储部分,而不是像{{ dump() }}
那样在html的中间。
如果你把dump()
的内容放入变量:
{% set d = dump() %}
你将得到所有的变量,但在“转储就绪”的HTML中,所以解析它会很痛苦。
希望有所帮助。
我认为19Gerhard85的答案非常好,虽然它可能需要一些调整,因为它匹配了一些空字符串。我喜欢尽可能使用现有的函数,这是一种主要使用twig函数的方法。您需要访问应用程序的twig环境。
/**
* @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
}
}
}
$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;
}
玩得开心 :-)