PHPでTwigテンプレート内のすべての変数を取得することは可能ですか？
例someTemplate.twig.php：
Hello {{ name }},
your new email is {{ email }}
今、私はこのようなことをしたいと思います：
$template = $twig->loadTemplate('someTemplate');
$variables = $template->getVariables();
$variablesには「name」と「email」が含まれているはずです。
これを実行したい理由は、Twigテンプレートと変数がユーザーによって動的に設定され、APIを介して変数を入力するCMSシステムで作業しているためです。
デフォルト値を未設定の変数に設定したいので、テンプレート内に存在するすべての変数のリストが必要です…</ p>
これは、現在のコンテキストで使用可能なすべてのトップレベルキーを取得するのに役立ちます。
<ol>
{% for key, value in _context %}
<li>{{ key }}</li>
{% endfor %}
</ol>
2019年更新
動作しますが{{ dump() }}、状況によっては、生成する情報が多すぎる場合（たとえば、再帰が原因で）、PHPから「メモリ枯渇」エラーが発生する場合があります。この場合、{{ dump(_context|keys) }}内容をダンプせずに、定義された変数のリストを名前で取得してみてください。
2017年の更新
{{ dump() }}フィルターを使用することで可能です。コメントでそれを指摘してくれてありがとう！
時代遅れ
それは不可能。
小枝テンプレートでこれらの変数を検索し、それらに|default('your_value')フィルターを追加できます。変数が定義されていて空ではないかどうかをチェックし、定義されていない場合は-で変数を値に置き換えます。
私のやり方は
<script>console.log({{ _context | json_encode | raw }});</script>
そして、DevToolsを使用してコンソールをチェックします
以前はそれは不可能でした。ただし、バージョン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。これはあなたが探していたものです。これは、すべての変数名をそれらの値に関連付ける配列です。
ただし、この特定の質問については、話しているこれらのカスタム変数をすべて同じアンブレラ変数の下に集めて、それらを取得することが頭痛の種にならないようにするのがおそらく最善でしょう。私はと呼ばれる配列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
}
}
}
かなり長い間duncanの答えを使用した後、私はついにテンプレートのすべての小枝変数をダンプする「正しい」方法を見つけました。
{% dump %}
それでおしまい。テンプレートで使用可能なすべての変数は、。のようにhtmlの途中ではなく、プロファイラーのダンプセクションにダンプされます{{ dump() }}。
の内容をdump()変数に入れる場合：
{% set d = dump() %}
すべての変数を取得しますが、「dumpready」htmlであるため、解析するのは面倒です。
お役に立てば幸いです。
$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, 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分かかりましたが、正規表現を使用すると、約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));
それが誰かを助けることを願っています:)
TwigASTから変数を推測するためにTwig2Schemaクラスを作成しました。ドキュメント内の変数を取得するには、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;
}
}
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 Extensionの作成についてサポートが必要な場合は、次のドキュメントを参照してください。
この質問には重複があります。そこで、上記よりも便利で強力な正規表現を見つけました。これは、より正確に一致するように改善されました。
\{\{(?!%)\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.
twigコンパイルプロセスを見ると、ignore_strict_checkというパラメーターがあることがわかります。これが真の場合、コンパイルでは欠落した変数がnullに置き換えられますが、偽のコンパイルでは実行時エラーがスローされます。ファイルtwig / src / Node / Expression/NameExpression.php行を参照してください。 63 symfonyでは、twigパッケージ構成を介してこのパラメーターを設定できます。strict_variables：false