Add missing deprecations for PHP templating layer

yceruto · yceruto · commit 61613d0bf0b0 · 2019-06-03T12:49:37.000-04:00
diff --git a/UPGRADE-4.4.md b/UPGRADE-4.4.md
@@ -31,6 +31,11 @@ Messenger
  * Deprecated passing a `ContainerInterface` instance as first argument of the `ConsumeMessagesCommand` constructor,
    pass a `RoutableMessageBus`  instance instead.
 
+FrameworkBundle
+---------------
+
+ * Deprecated support for `templating` engine in `TemplateController`, use Twig instead
+
 MonologBridge
 --------------
 
diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
@@ -219,6 +219,7 @@ FrameworkBundle
  * Removed support for legacy translations directories `src/Resources/translations/` and `src/Resources/<BundleName>/translations/`, use `translations/` instead.
  * Support for the legacy directory structure in `translation:update` and `debug:translation` commands has been removed.
  * Removed the "Psr\SimpleCache\CacheInterface" / "cache.app.simple" service, use "Symfony\Contracts\Cache\CacheInterface" / "cache.app" instead.
+ * Removed support for `templating` engine in `TemplateController`, use Twig instead
 
 HttpFoundation
 --------------
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+4.4.0
+-----
+
+ * Deprecated support for `templating` engine in `TemplateController`, use Twig instead
+
 4.3.0
 -----
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Controller/TemplateController.php b/src/Symfony/Bundle/FrameworkBundle/Controller/TemplateController.php
@@ -29,6 +29,10 @@ class TemplateController
 
     public function __construct(Environment $twig = null, EngineInterface $templating = null)
     {
+        if (null !== $templating) {
+            @trigger_error(sprintf('Using a "%s" instance for "%s" is deprecated since version 4.4; use a \Twig\Environment instance instead.', EngineInterface::class, __CLASS__), E_USER_DEPRECATED);
+        }
+
         $this->twig = $twig;
         $this->templating = $templating;
     }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Controller/TemplateControllerTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Controller/TemplateControllerTest.php
@@ -31,6 +31,9 @@ public function testTwig()
         $this->assertEquals('bar', $controller('mytemplate')->getContent());
     }
 
+    /**
+     * @group legacy
+     */
     public function testTemplating()
     {
         $templating = $this->getMockBuilder(EngineInterface::class)->getMock();
diff --git a/src/Symfony/Bundle/TwigBundle/CacheWarmer/TemplateCacheCacheWarmer.php b/src/Symfony/Bundle/TwigBundle/CacheWarmer/TemplateCacheCacheWarmer.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Bundle\TwigBundle\CacheWarmer;
 
+@trigger_error('The '.TemplateCacheCacheWarmer::class.' class is deprecated since version 4.4 and will be removed in 5.0; use Twig instead.', E_USER_DEPRECATED);
+
 use Psr\Container\ContainerInterface;
 use Symfony\Bundle\FrameworkBundle\CacheWarmer\TemplateFinderInterface;
 use Symfony\Component\DependencyInjection\ServiceSubscriberInterface;
@@ -26,6 +28,8 @@
  * as the Twig loader will need the cache generated by it.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since version 4.4, to be removed in 5.0; use Twig instead.
  */
 class TemplateCacheCacheWarmer implements CacheWarmerInterface, ServiceSubscriberInterface
 {
diff --git a/src/Symfony/Bundle/TwigBundle/DependencyInjection/Compiler/ExtensionPass.php b/src/Symfony/Bundle/TwigBundle/DependencyInjection/Compiler/ExtensionPass.php
@@ -105,6 +105,7 @@ public function process(ContainerBuilder $container)
         } else {
             $container->setAlias('twig.loader.filesystem', new Alias('twig.loader.native_filesystem', false));
             $container->removeDefinition('templating.engine.twig');
+            $container->removeDefinition('twig.cache_warmer');
         }
 
         if ($container->has('assets.packages')) {
diff --git a/src/Symfony/Bundle/TwigBundle/Resources/config/templating.xml b/src/Symfony/Bundle/TwigBundle/Resources/config/templating.xml
@@ -17,6 +17,8 @@
             <argument type="service" id="twig" />
             <argument type="service" id="templating.name_parser" />
             <argument type="service" id="templating.locator" />
+
+            <deprecated>The "%service_id%" service is deprecated since Symfony 4.4 and will be removed in 5.0.</deprecated>
         </service>
     </services>
 </container>
diff --git a/src/Symfony/Bundle/TwigBundle/Resources/config/twig.xml b/src/Symfony/Bundle/TwigBundle/Resources/config/twig.xml
@@ -35,6 +35,8 @@
             <argument type="service" id="Psr\Container\ContainerInterface" />
             <argument type="service" id="templating.finder" on-invalid="ignore" />
             <argument type="collection" /> <!-- Twig paths -->
+
+            <deprecated>The "%service_id%" service is deprecated since Symfony 4.4 and will be removed in 5.0.</deprecated>
         </service>
 
         <service id="twig.template_iterator" class="Symfony\Bundle\TwigBundle\TemplateIterator">
diff --git a/src/Symfony/Component/HttpKernel/Fragment/HIncludeFragmentRenderer.php b/src/Symfony/Component/HttpKernel/Fragment/HIncludeFragmentRenderer.php
@@ -52,6 +52,8 @@ public function __construct($templating = null, UriSigner $signer = null, string
      * @param EngineInterface|Environment|null $templating An EngineInterface or an Environment instance
      *
      * @throws \InvalidArgumentException
+     *
+     * @internal
      */
     public function setTemplating($templating)
     {

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,10 @@ class TemplateController`
`29`	`29`
`30`	`30`	`public function __construct(Environment $twig = null, EngineInterface $templating = null)`
`31`	`31`	`{`
	`32`	`+ if (null !== $templating) {`
	`33`	`+ @trigger_error(sprintf('Using a "%s" instance for "%s" is deprecated since version 4.4; use a \Twig\Environment instance instead.', EngineInterface::class, __CLASS__), E_USER_DEPRECATED);`
	`34`	`+ }`
	`35`	`+`
`32`	`36`	`$this->twig = $twig;`
`33`	`37`	`$this->templating = $templating;`
`34`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,9 @@ public function testTwig()`
`31`	`31`	`$this->assertEquals('bar', $controller('mytemplate')->getContent());`
`32`	`32`	`}`
`33`	`33`
	`34`	`+ /**`
	`35`	`+ * @group legacy`
	`36`	`+ */`
`34`	`37`	`public function testTemplating()`
`35`	`38`	`{`
`36`	`39`	`$templating = $this->getMockBuilder(EngineInterface::class)->getMock();`
Original file line number	Diff line number	Diff line change
`@@ -105,6 +105,7 @@ public function process(ContainerBuilder $container)`
`105`	`105`	`} else {`
`106`	`106`	`$container->setAlias('twig.loader.filesystem', new Alias('twig.loader.native_filesystem', false));`
`107`	`107`	`$container->removeDefinition('templating.engine.twig');`
	`108`	`+ $container->removeDefinition('twig.cache_warmer');`
`108`	`109`	`}`
`109`	`110`
`110`	`111`	`if ($container->has('assets.packages')) {`
Original file line number	Diff line number	Diff line change
`@@ -52,6 +52,8 @@ public function __construct($templating = null, UriSigner $signer = null, string`
`52`	`52`	`* @param EngineInterface\|Environment\|null $templating An EngineInterface or an Environment instance`
`53`	`53`	`*`
`54`	`54`	`* @throws \InvalidArgumentException`
	`55`	`+ *`
	`56`	`+ * @internal`
`55`	`57`	`*/`
`56`	`58`	`public function setTemplating($templating)`
`57`	`59`	`{`