Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 8b390f3

Browse files
ycerutoyceruto
committed
Deprecating support for legacy templates directories
1 parent 557f85d commit 8b390f3

File tree

13 files changed

+73
-21
lines changed

13 files changed

+73
-21
lines changed

‎UPGRADE-4.2.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,7 @@ TwigBundle
257257
----------
258258

259259
* The `transchoice` tag and filter have been deprecated, use the `trans` ones instead with a `%count%` parameter.
260+
* Deprecated support for legacy templates directories `src/Resources/views/` and `src/Resources/<BundleName>/views/`, use `templates/` and `templates/bundles/<BundleName>/` instead.
260261

261262
Validator
262263
---------

‎UPGRADE-5.0.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,7 @@ TwigBundle
256256

257257
* The default value (`false`) of the `twig.strict_variables` configuration option has been changed to `%kernel.debug%`.
258258
* The `transchoice` tag and filter have been removed, use the `trans` ones instead with a `%count%` parameter.
259+
* Removed support for legacy templates directories `src/Resources/views/` and `src/Resources/<BundleName>/views/`, use `templates/` and `templates/bundles/<BundleName>/` instead.
259260

260261
Validator
261262
--------

‎src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/Resources/views/base.html.twig renamed to ‎src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/templates/base.html.twig

File renamed without changes.

‎src/Symfony/Bundle/SecurityBundle/composer.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
"symfony/framework-bundle": "~4.2",
3838
"symfony/http-foundation": "~3.4|~4.0",
3939
"symfony/translation": "~3.4|~4.0",
40-
"symfony/twig-bundle": "~3.4|~4.0",
40+
"symfony/twig-bundle": "~4.2",
4141
"symfony/twig-bridge": "~3.4|~4.0",
4242
"symfony/process": "~3.4|~4.0",
4343
"symfony/validator": "~3.4|~4.0",
@@ -49,6 +49,7 @@
4949
},
5050
"conflict": {
5151
"symfony/browser-kit": "<4.2",
52+
"symfony/twig-bundle": "<4.2",
5253
"symfony/var-dumper": "<3.4",
5354
"symfony/event-dispatcher": "<3.4",
5455
"symfony/framework-bundle": "<4.2",

‎src/Symfony/Bundle/TwigBundle/CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
CHANGELOG
22
=========
33

4+
4.2.0
5+
-----
6+
7+
* deprecated support for legacy templates directories `src/Resources/views/` and `src/Resources/<BundleName>/views/`, use `templates/` and `templates/bundles/<BundleName>/` instead.
8+
49
4.1.0
510
-----
611

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

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ public function load(array $configs, ContainerBuilder $container)
7474

7575
$container->setParameter('twig.form.resources', $config['form_themes']);
7676
$container->setParameter('twig.default_path', $config['default_path']);
77+
$defaultTwigPath = $container->getParameterBag()->resolveValue($config['default_path']);
7778

7879
$envConfiguratorDefinition = $container->getDefinition('twig.configurator.environment');
7980
$envConfiguratorDefinition->replaceArgument(0, $config['date']['format']);
@@ -115,14 +116,18 @@ public function load(array $configs, ContainerBuilder $container)
115116
}
116117

117118
if (file_exists($dir = $container->getParameter('kernel.root_dir').'/Resources/views')) {
119+
if ($dir !== $defaultTwigPath) {
120+
@trigger_error(sprintf('Templates directory "%s" is deprecated since Symfony 4.2, use "%s" instead.', $dir, $defaultTwigPath), E_USER_DEPRECATED);
121+
}
122+
118123
$twigFilesystemLoaderDefinition->addMethodCall('addPath', array($dir));
119124
}
120125
$container->addResource(new FileExistenceResource($dir));
121126

122-
if (file_exists($dir = $container->getParameterBag()->resolveValue($config['default_path']))) {
123-
$twigFilesystemLoaderDefinition->addMethodCall('addPath', array($dir));
127+
if (file_exists($defaultTwigPath)) {
128+
$twigFilesystemLoaderDefinition->addMethodCall('addPath', array($defaultTwigPath));
124129
}
125-
$container->addResource(new FileExistenceResource($dir));
130+
$container->addResource(new FileExistenceResource($defaultTwigPath));
126131

127132
if (!empty($config['globals'])) {
128133
$def = $container->getDefinition('twig');
@@ -164,15 +169,19 @@ private function getBundleTemplatePaths(ContainerBuilder $container, array $conf
164169
{
165170
$bundleHierarchy = array();
166171
foreach ($container->getParameter('kernel.bundles_metadata') as $name => $bundle) {
172+
$defaultOverrideBundlePath = $container->getParameterBag()->resolveValue($config['default_path']).'/bundles/'.$name;
173+
167174
if (file_exists($dir = $container->getParameter('kernel.root_dir').'/Resources/'.$name.'/views')) {
175+
@trigger_error(sprintf('Templates directory "%s" is deprecated since Symfony 4.2, use "%s" instead.', $dir, $defaultOverrideBundlePath), E_USER_DEPRECATED);
176+
168177
$bundleHierarchy[$name][] = $dir;
169178
}
170179
$container->addResource(new FileExistenceResource($dir));
171180

172-
if (file_exists($dir = $container->getParameterBag()->resolveValue($config['default_path']).'/bundles/'.$name)) {
173-
$bundleHierarchy[$name][] = $dir;
181+
if (file_exists($defaultOverrideBundlePath)) {
182+
$bundleHierarchy[$name][] = $defaultOverrideBundlePath;
174183
}
175-
$container->addResource(new FileExistenceResource($dir));
184+
$container->addResource(new FileExistenceResource($defaultOverrideBundlePath));
176185

177186
if (file_exists($dir = $bundle['path'].'/Resources/views')) {
178187
$bundleHierarchy[$name][] = $dir;

‎src/Symfony/Bundle/TwigBundle/Tests/DependencyInjection/Fixtures/Resources/TwigBundle/views/layout.html.twig

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎src/Symfony/Bundle/TwigBundle/Tests/DependencyInjection/Fixtures/Resources/views/layout.html.twig

Lines changed: 0 additions & 1 deletion
This file was deleted.

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

Lines changed: 39 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -193,11 +193,46 @@ public function testTwigLoaderPaths($format)
193193
array('namespaced_path1', 'namespace1'),
194194
array('namespaced_path2', 'namespace2'),
195195
array('namespaced_path3', 'namespace3'),
196-
array(__DIR__.'/Fixtures/Resources/TwigBundle/views', 'Twig'),
197196
array(__DIR__.'/Fixtures/templates/bundles/TwigBundle', 'Twig'),
198197
array(realpath(__DIR__.'/../..').'/Resources/views', 'Twig'),
199198
array(realpath(__DIR__.'/../..').'/Resources/views', '!Twig'),
200-
array(__DIR__.'/Fixtures/Resources/views'),
199+
array(__DIR__.'/Fixtures/templates'),
200+
), $paths);
201+
}
202+
203+
/**
204+
* @group legacy
205+
* @dataProvider getFormats
206+
* @expectedDeprecation Templates directory "%s/Resources/TwigBundle/views" is deprecated since Symfony 4.2, use "%s/templates/bundles/TwigBundle" instead.
207+
* @expectedDeprecation Templates directory "%s/Resources/views" is deprecated since Symfony 4.2, use "%s/templates" instead.
208+
*/
209+
public function testLegacyTwigLoaderPaths($format)
210+
{
211+
$container = $this->createContainer(__DIR__.'/../Fixtures/templates');
212+
$container->registerExtension(new TwigExtension());
213+
$this->loadFromFile($container, 'full', $format);
214+
$this->loadFromFile($container, 'extra', $format);
215+
$this->compileContainer($container);
216+
217+
$def = $container->getDefinition('twig.loader.native_filesystem');
218+
$paths = array();
219+
foreach ($def->getMethodCalls() as $call) {
220+
if ('addPath' === $call[0] && false === strpos($call[1][0], 'Form')) {
221+
$paths[] = $call[1];
222+
}
223+
}
224+
225+
$this->assertEquals(array(
226+
array('path1'),
227+
array('path2'),
228+
array('namespaced_path1', 'namespace1'),
229+
array('namespaced_path2', 'namespace2'),
230+
array('namespaced_path3', 'namespace3'),
231+
array(__DIR__.'/../Fixtures/templates/Resources/TwigBundle/views', 'Twig'),
232+
array(__DIR__.'/Fixtures/templates/bundles/TwigBundle', 'Twig'),
233+
array(realpath(__DIR__.'/../..').'/Resources/views', 'Twig'),
234+
array(realpath(__DIR__.'/../..').'/Resources/views', '!Twig'),
235+
array(__DIR__.'/../Fixtures/templates/Resources/views'),
201236
array(__DIR__.'/Fixtures/templates'),
202237
), $paths);
203238
}
@@ -271,11 +306,11 @@ public function testRuntimeLoader()
271306
$this->assertEquals('foo', $args['FooClass']->getValues()[0]);
272307
}
273308

274-
private function createContainer()
309+
private function createContainer(string $rootDir = __DIR__.'/Fixtures')
275310
{
276311
$container = new ContainerBuilder(new ParameterBag(array(
277312
'kernel.cache_dir' => __DIR__,
278-
'kernel.root_dir' => __DIR__.'/Fixtures',
313+
'kernel.root_dir' => $rootDir,
279314
'kernel.project_dir' => __DIR__,
280315
'kernel.charset' => 'UTF-8',
281316
'kernel.debug' => false,

‎src/Symfony/Bundle/TwigBundle/Tests/Fixtures/templates/Resources/TwigBundle/views/layout.html.twig

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{# Twig template #}

0 commit comments

Comments
 (0)