Skip to content

Commit 4177ee9

Browse files
fabpotfabpot
committed
[TwigBundle] Moved the setting of the default escaping strategy from the Twig engine to the Twig environment
1 parent 87e0e22 commit 4177ee9

File tree

5 files changed

+60
-22
lines changed

5 files changed

+60
-22
lines changed

‎src/Symfony/Bundle/TwigBundle/DependencyInjection/Configuration.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,9 @@ private function addTwigOptions(ArrayNodeDefinition $rootNode)
124124
$rootNode
125125
->fixXmlConfig('path')
126126
->children()
127-
->scalarNode('autoescape')->end()
127+
->variableNode('autoescape')
128+
->defaultValue(array('Symfony\Bundle\TwigBundle\TwigDefaultEscapingStrategy', 'guess'))
129+
->end()
128130
->scalarNode('autoescape_service')->defaultNull()->end()
129131
->scalarNode('autoescape_service_method')->defaultNull()->end()
130132
->scalarNode('base_template_class')->example('Twig_Template')->end()

‎src/Symfony/Bundle/TwigBundle/DependencyInjection/TwigExtension.php

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -109,12 +109,9 @@ public function load(array $configs, ContainerBuilder $container)
109109
}
110110

111111
if (isset($config['autoescape_service']) && isset($config['autoescape_service_method'])) {
112-
$container->findDefinition('templating.engine.twig')->addMethodCall('setDefaultEscapingStrategy', array(array(new Reference($config['autoescape_service']), $config['autoescape_service_method'])));
113-
114-
unset($config['autoescape_service'], $config['autoescape_service_method']);
115-
} elseif (!isset($config['autoescape'])) {
116-
$container->findDefinition('templating.engine.twig')->addMethodCall('setDefaultEscapingStrategy', array(array(new Reference('templating.engine.twig'), 'guessDefaultEscapingStrategy')));
112+
$config['autoescape'] = array(new Reference($config['autoescape_service']), $config['autoescape_service_method']);
117113
}
114+
unset($config['autoescape_service'], $config['autoescape_service_method']);
118115

119116
$container->setParameter('twig.options', $config);
120117

‎src/Symfony/Bundle/TwigBundle/Tests/DependencyInjection/TwigExtensionTest.php

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,8 @@ public function testLoadCustomTemplateEscapingGuesserConfiguration($format)
9595
$this->loadFromFile($container, 'customTemplateEscapingGuesser', $format);
9696
$this->compileContainer($container);
9797

98-
$this->assertTemplateEscapingGuesserDefinition($container, 'my_project.some_bundle.template_escaping_guesser', 'guess');
98+
$options = $container->getParameter('twig.options');
99+
$this->assertEquals(array(new Reference('my_project.some_bundle.template_escaping_guesser'), 'guess'), $options['autoescape']);
99100
}
100101

101102
/**
@@ -108,7 +109,8 @@ public function testLoadDefaultTemplateEscapingGuesserConfiguration($format)
108109
$this->loadFromFile($container, 'empty', $format);
109110
$this->compileContainer($container);
110111

111-
$this->assertTemplateEscapingGuesserDefinition($container, 'templating.engine.twig', 'guessDefaultEscapingStrategy');
112+
$options = $container->getParameter('twig.options');
113+
$this->assertEquals(array('Symfony\Bundle\TwigBundle\TwigDefaultEscapingStrategy', 'guess'), $options['autoescape']);
112114
}
113115

114116
public function testGlobalsWithDifferentTypesAndValues()
@@ -219,18 +221,4 @@ private function loadFromFile(ContainerBuilder $container, $file, $format)
219221

220222
$loader->load($file.'.'.$format);
221223
}
222-
223-
private function assertTemplateEscapingGuesserDefinition(ContainerBuilder $container, $serviceId, $serviceMethod)
224-
{
225-
$def = $container->getDefinition('templating.engine.twig');
226-
227-
$this->assertCount(1, $def->getMethodCalls());
228-
229-
foreach ($def->getMethodCalls() as $call) {
230-
if ('setDefaultEscapingStrategy' === $call[0]) {
231-
$this->assertSame($serviceId, (string) $call[1][0][0]);
232-
$this->assertSame($serviceMethod, $call[1][0][1]);
233-
}
234-
}
235-
}
236224
}

‎src/Symfony/Bundle/TwigBundle/TwigDefaultEscapingStrategy.php

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Bundle\TwigBundle;
13+
14+
use Symfony\Bridge\Twig\TwigEngine as BaseEngine;
15+
use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
16+
use Symfony\Bundle\FrameworkBundle\Templating\TemplateReference;
17+
use Symfony\Component\Templating\TemplateNameParserInterface;
18+
use Symfony\Component\HttpFoundation\Response;
19+
use Symfony\Component\Config\FileLocatorInterface;
20+
21+
/**
22+
* @author Fabien Potencier <fabien@symfony.com>
23+
*/
24+
class TwigDefaultEscapingStrategy
25+
{
26+
public static function guess($filename)
27+
{
28+
// remove .twig
29+
$filename = substr($filename, 0, -5);
30+
31+
// get the format
32+
$format = substr($filename, strrpos($filename, '.') + 1);
33+
34+
if ('js' === $format) {
35+
return 'js';
36+
}
37+
38+
if ('txt' === $format) {
39+
return false;
40+
}
41+
42+
return 'html';
43+
}
44+
}

‎src/Symfony/Bundle/TwigBundle/TwigEngine.php

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,18 @@ public function __construct(\Twig_Environment $environment, TemplateNameParserIn
4141
$this->locator = $locator;
4242
}
4343

44+
/**
45+
* @deprecated Deprecated since version 2.3, to be removed in 3.0. Inject the escaping
46+
* strategy on Twig_Environment instead
47+
*/
4448
public function setDefaultEscapingStrategy($strategy)
4549
{
4650
$this->environment->getExtension('escaper')->setDefaultStrategy($strategy);
4751
}
4852

53+
/**
54+
* @deprecated Deprecated since version 2.3, to be removed in 3.0. Use TwigDefaultEscapingStrategy instead.
55+
*/
4956
public function guessDefaultEscapingStrategy($filename)
5057
{
5158
// remove .twig

0 commit comments

Comments
 (0)