vendor/jms/translation-bundle/Twig/DefaultApplyingNodeVisitor.php line 57

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6. * Copyright 2011 Johannes M. Schmitt <schmittjoh@gmail.com>
  7. *
  8. * Licensed under the Apache License, Version 2.0 (the "License");
  9. * you may not use this file except in compliance with the License.
  10. * You may obtain a copy of the License at
  11. *
  12. * http://www.apache.org/licenses/LICENSE-2.0
  13. *
  14. * Unless required by applicable law or agreed to in writing, software
  15. * distributed under the License is distributed on an "AS IS" BASIS,
  16. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17. * See the License for the specific language governing permissions and
  18. * limitations under the License.
  19. */
  21. namespace JMS\TranslationBundle\Twig;
  23. use JMS\TranslationBundle\Exception\RuntimeException;
  24. use JMS\TranslationBundle\Twig\Node\Transchoice;
  25. use Twig\Environment;
  26. use Twig\Node\Expression\ArrayExpression;
  27. use Twig\Node\Expression\Binary\EqualBinary;
  28. use Twig\Node\Expression\ConditionalExpression;
  29. use Twig\Node\Expression\ConstantExpression;
  30. use Twig\Node\Expression\FilterExpression;
  31. use Twig\Node\Node;
  32. use Twig\NodeVisitor\AbstractNodeVisitor;
  34. /**
  35. * Applies the value of the "desc" filter if the "trans" filter has no
  36. * translations.
  37. *
  38. * This is only active in your development environment.
  39. *
  40. * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  41. */
  42. class DefaultApplyingNodeVisitor extends AbstractNodeVisitor
  43. {
  44. /**
  45. * @var bool
  46. */
  47. private $enabled = true;
  49. public function setEnabled($bool)
  50. {
  51. $this->enabled = (bool) $bool;
  52. }
  54. /**
  55. * @return Node
  56. */
  57. public function doEnterNode(Node $node, Environment $env)
  58. {
  59. if (!$this->enabled) {
  60. return $node;
  61. }
  63. if (
  64. $node instanceof FilterExpression
  65. && 'desc' === $node->getNode('filter')->getAttribute('value')
  66. ) {
  67. $transNode = $node->getNode('node');
  68. while (
  69. $transNode instanceof FilterExpression
  70. && 'trans' !== $transNode->getNode('filter')->getAttribute('value')
  71. && 'transchoice' !== $transNode->getNode('filter')->getAttribute('value')
  72. ) {
  73. $transNode = $transNode->getNode('node');
  74. }
  76. if (!$transNode instanceof FilterExpression) {
  77. throw new RuntimeException(sprintf('The "desc" filter in "%s" line %d must be applied after a "trans", or "transchoice" filter.', $node->getTemplateName(), $node->getTemplateLine()));
  78. }
  80. $wrappingNode = $node->getNode('node');
  82. $testNode = clone $wrappingNode;
  83. $arguments = iterator_to_array($node->getNode('arguments'));
  84. $defaultNode = $arguments[0];
  86. // if the |transchoice filter is used, delegate the call to the TranslationExtension
  87. // so that we can catch a possible exception when the default translation has not yet
  88. // been extracted
  89. if ('transchoice' === $transNode->getNode('filter')->getAttribute('value')) {
  90. $transchoiceArguments = new ArrayExpression([], $transNode->getTemplateLine());
  91. $transchoiceArguments->addElement($wrappingNode->getNode('node'));
  92. $transchoiceArguments->addElement($defaultNode);
  93. foreach ($wrappingNode->getNode('arguments') as $arg) {
  94. $transchoiceArguments->addElement($arg);
  95. }
  97. $transchoiceNode = new Transchoice($transchoiceArguments, $transNode->getTemplateLine());
  98. $node->setNode('node', $transchoiceNode);
  100. return $node;
  101. }
  103. $wrappingNodeArguments = iterator_to_array($wrappingNode->getNode('arguments'));
  105. // if the |trans filter has replacements parameters
  106. // (e.g. |trans({'%foo%': 'bar'}))
  107. if (isset($wrappingNodeArguments[0])) {
  108. $lineno = $wrappingNode->getTemplateLine();
  110. // remove the replacements from the test node
  111. $testNodeArguments = iterator_to_array($testNode->getNode('arguments'));
  112. $testNodeArguments[0] = new ArrayExpression([], $lineno);
  113. $testNode->setNode('arguments', new Node($testNodeArguments));
  115. // wrap the default node in a |replace filter
  116. $defaultNode = new FilterExpression(
  117. $arguments[0],
  118. new ConstantExpression('replace', $lineno),
  119. new Node([$wrappingNodeArguments[0]]),
  120. $lineno
  121. );
  122. }
  124. $condition = new ConditionalExpression(
  125. new EqualBinary($testNode, $transNode->getNode('node'), $wrappingNode->getTemplateLine()),
  126. $defaultNode,
  127. clone $wrappingNode,
  128. $wrappingNode->getTemplateLine()
  129. );
  130. $node->setNode('node', $condition);
  131. }
  133. return $node;
  134. }
  136. /**
  137. * @return Node
  138. */
  139. public function doLeaveNode(Node $node, Environment $env)
  140. {
  141. return $node;
  142. }
  144. /**
  145. * @return int
  146. */
  147. public function getPriority()
  148. {
  149. return -2;
  150. }
  151. }