[Templating] deprecate the component

kbond · fabpot · commit 2a07431c7440 · 2023-07-30T15:03:05.000+02:00
diff --git a/UPGRADE-6.4.md b/UPGRADE-6.4.md
@@ -80,6 +80,11 @@ Serializer
  * Deprecate Doctrine annotations support in favor of native attributes
  * Deprecate passing an annotation reader to the constructor of `AnnotationLoader`
 
+Templating
+----------
+
+ * The component is deprecated and will be removed in 7.0. Use Twig instead.
+
 Validator
 ---------
 
diff --git a/src/Symfony/Component/Templating/CHANGELOG.md b/src/Symfony/Component/Templating/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+6.4
+---
+
+* Deprecate the component, use Twig instead
+
 2.5.0
 -----
 
diff --git a/src/Symfony/Component/Templating/DelegatingEngine.php b/src/Symfony/Component/Templating/DelegatingEngine.php
@@ -11,10 +11,14 @@
 
 namespace Symfony\Component\Templating;
 
+trigger_deprecation('symfony/templating', '6.4', '"%s" is deprecated since version 6.4 and will be removed in 7.0. Use Twig instead.', DelegatingEngine::class);
+
 /**
  * DelegatingEngine selects an engine for a given template.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 6.4, use Twig instead
  */
 class DelegatingEngine implements EngineInterface, StreamingEngineInterface
 {
diff --git a/src/Symfony/Component/Templating/EngineInterface.php b/src/Symfony/Component/Templating/EngineInterface.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Templating;
 
+trigger_deprecation('symfony/templating', '6.4', '"%s" is deprecated since version 6.4 and will be removed in 7.0. Use Twig instead.', EngineInterface::class);
+
 /**
  * EngineInterface is the interface each engine must implement.
  *
@@ -27,6 +29,8 @@
  * the template.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 6.4, use Twig instead
  */
 interface EngineInterface
 {
diff --git a/src/Symfony/Component/Templating/Helper/Helper.php b/src/Symfony/Component/Templating/Helper/Helper.php
@@ -11,13 +11,17 @@
 
 namespace Symfony\Component\Templating\Helper;
 
+trigger_deprecation('symfony/templating', '6.4', '"%s" is deprecated since version 6.4 and will be removed in 7.0. Use Twig instead.', Helper::class);
+
 /**
  * Helper is the base class for all helper classes.
  *
  * Most of the time, a Helper is an adapter around an existing
  * class that exposes a read-only interface for templates.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 6.4, use Twig instead
  */
 abstract class Helper implements HelperInterface
 {
diff --git a/src/Symfony/Component/Templating/Helper/HelperInterface.php b/src/Symfony/Component/Templating/Helper/HelperInterface.php
@@ -11,10 +11,14 @@
 
 namespace Symfony\Component\Templating\Helper;
 
+trigger_deprecation('symfony/templating', '6.4', '"%s" is deprecated since version 6.4 and will be removed in 7.0. Use Twig instead.', HelperInterface::class);
+
 /**
  * HelperInterface is the interface all helpers must implement.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 6.4, use Twig instead
  */
 interface HelperInterface
 {
diff --git a/src/Symfony/Component/Templating/Helper/SlotsHelper.php b/src/Symfony/Component/Templating/Helper/SlotsHelper.php
@@ -11,10 +11,14 @@
 
 namespace Symfony\Component\Templating\Helper;
 
+trigger_deprecation('symfony/templating', '6.4', '"%s" is deprecated since version 6.4 and will be removed in 7.0. Use Twig instead.', SlotsHelper::class);
+
 /**
  * SlotsHelper manages template slots.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 6.4, use Twig instead
  */
 class SlotsHelper extends Helper
 {
diff --git a/src/Symfony/Component/Templating/Loader/CacheLoader.php b/src/Symfony/Component/Templating/Loader/CacheLoader.php
@@ -15,6 +15,8 @@
 use Symfony\Component\Templating\Storage\Storage;
 use Symfony\Component\Templating\TemplateReferenceInterface;
 
+trigger_deprecation('symfony/templating', '6.4', '"%s" is deprecated since version 6.4 and will be removed in 7.0. Use Twig instead.', CacheLoader::class);
+
 /**
  * CacheLoader is a loader that caches other loaders responses
  * on the filesystem.
@@ -23,6 +25,8 @@
  * All other mechanism would imply the use of `eval()`.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 6.4, use Twig instead
  */
 class CacheLoader extends Loader
 {
diff --git a/src/Symfony/Component/Templating/Loader/ChainLoader.php b/src/Symfony/Component/Templating/Loader/ChainLoader.php
@@ -14,10 +14,14 @@
 use Symfony\Component\Templating\Storage\Storage;
 use Symfony\Component\Templating\TemplateReferenceInterface;
 
+trigger_deprecation('symfony/templating', '6.4', '"%s" is deprecated since version 6.4 and will be removed in 7.0. Use Twig instead.', ChainLoader::class);
+
 /**
  * ChainLoader is a loader that calls other loaders to load templates.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 6.4, use Twig instead
  */
 class ChainLoader extends Loader
 {
diff --git a/src/Symfony/Component/Templating/Loader/FilesystemLoader.php b/src/Symfony/Component/Templating/Loader/FilesystemLoader.php
@@ -15,10 +15,14 @@
 use Symfony\Component\Templating\Storage\Storage;
 use Symfony\Component\Templating\TemplateReferenceInterface;
 
+trigger_deprecation('symfony/templating', '6.4', '"%s" is deprecated since version 6.4 and will be removed in 7.0. Use Twig instead.', FilesystemLoader::class);
+
 /**
  * FilesystemLoader is a loader that read templates from the filesystem.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 6.4, use Twig instead
  */
 class FilesystemLoader extends Loader
 {
diff --git a/src/Symfony/Component/Templating/Loader/Loader.php b/src/Symfony/Component/Templating/Loader/Loader.php
@@ -13,10 +13,14 @@
 
 use Psr\Log\LoggerInterface;
 
+trigger_deprecation('symfony/templating', '6.4', '"%s" is deprecated since version 6.4 and will be removed in 7.0. Use Twig instead.', Loader::class);
+
 /**
  * Loader is the base class for all template loader classes.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 6.4, use Twig instead
  */
 abstract class Loader implements LoaderInterface
 {
diff --git a/src/Symfony/Component/Templating/Loader/LoaderInterface.php b/src/Symfony/Component/Templating/Loader/LoaderInterface.php
@@ -14,10 +14,14 @@
 use Symfony\Component\Templating\Storage\Storage;
 use Symfony\Component\Templating\TemplateReferenceInterface;
 
+trigger_deprecation('symfony/templating', '6.4', '"%s" is deprecated since version 6.4 and will be removed in 7.0. Use Twig instead.', LoaderInterface::class);
+
 /**
  * LoaderInterface is the interface all loaders must implement.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 6.4, use Twig instead
  */
 interface LoaderInterface
 {
diff --git a/src/Symfony/Component/Templating/PhpEngine.php b/src/Symfony/Component/Templating/PhpEngine.php
@@ -17,12 +17,16 @@
 use Symfony\Component\Templating\Storage\Storage;
 use Symfony\Component\Templating\Storage\StringStorage;
 
+trigger_deprecation('symfony/templating', '6.4', '"%s" is deprecated since version 6.4 and will be removed in 7.0. Use Twig instead.', PhpEngine::class);
+
 /**
  * PhpEngine is an engine able to render PHP templates.
  *
  * @implements \ArrayAccess<string, HelperInterface>
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 6.4, use Twig instead
  */
 class PhpEngine implements EngineInterface, \ArrayAccess
 {
diff --git a/src/Symfony/Component/Templating/Storage/FileStorage.php b/src/Symfony/Component/Templating/Storage/FileStorage.php
@@ -11,10 +11,14 @@
 
 namespace Symfony\Component\Templating\Storage;
 
+trigger_deprecation('symfony/templating', '6.4', '"%s" is deprecated since version 6.4 and will be removed in 7.0. Use Twig instead.', FileStorage::class);
+
 /**
  * FileStorage represents a template stored on the filesystem.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 6.4, use Twig instead
  */
 class FileStorage extends Storage
 {
diff --git a/src/Symfony/Component/Templating/Storage/Storage.php b/src/Symfony/Component/Templating/Storage/Storage.php
@@ -11,10 +11,14 @@
 
 namespace Symfony\Component\Templating\Storage;
 
+trigger_deprecation('symfony/templating', '6.4', '"%s" is deprecated since version 6.4 and will be removed in 7.0. Use Twig instead.', Storage::class);
+
 /**
  * Storage is the base class for all storage classes.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 6.4, use Twig instead
  */
 abstract class Storage
 {
diff --git a/src/Symfony/Component/Templating/Storage/StringStorage.php b/src/Symfony/Component/Templating/Storage/StringStorage.php
@@ -11,10 +11,14 @@
 
 namespace Symfony\Component\Templating\Storage;
 
+trigger_deprecation('symfony/templating', '6.4', '"%s" is deprecated since version 6.4 and will be removed in 7.0. Use Twig instead.', StringStorage::class);
+
 /**
  * StringStorage represents a template stored in a string.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 6.4, use Twig instead
  */
 class StringStorage extends Storage
 {
diff --git a/src/Symfony/Component/Templating/StreamingEngineInterface.php b/src/Symfony/Component/Templating/StreamingEngineInterface.php
@@ -11,10 +11,14 @@
 
 namespace Symfony\Component\Templating;
 
+trigger_deprecation('symfony/templating', '6.4', '"%s" is deprecated since version 6.4 and will be removed in 7.0. Use Twig instead.', StreamingEngineInterface::class);
+
 /**
  * StreamingEngineInterface provides a method that knows how to stream a template.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 6.4, use Twig instead
  */
 interface StreamingEngineInterface
 {
diff --git a/src/Symfony/Component/Templating/TemplateNameParser.php b/src/Symfony/Component/Templating/TemplateNameParser.php
@@ -11,13 +11,17 @@
 
 namespace Symfony\Component\Templating;
 
+trigger_deprecation('symfony/templating', '6.4', '"%s" is deprecated since version 6.4 and will be removed in 7.0. Use Twig instead.', TemplateNameParser::class);
+
 /**
  * TemplateNameParser is the default implementation of TemplateNameParserInterface.
  *
  * This implementation takes everything as the template name
  * and the extension for the engine.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 6.4, use Twig instead
  */
 class TemplateNameParser implements TemplateNameParserInterface
 {
diff --git a/src/Symfony/Component/Templating/TemplateNameParserInterface.php b/src/Symfony/Component/Templating/TemplateNameParserInterface.php
@@ -11,11 +11,15 @@
 
 namespace Symfony\Component\Templating;
 
+trigger_deprecation('symfony/templating', '6.4', '"%s" is deprecated since version 6.4 and will be removed in 7.0. Use Twig instead.', TemplateNameParserInterface::class);
+
 /**
  * TemplateNameParserInterface converts template names to TemplateReferenceInterface
  * instances.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 6.4, use Twig instead
  */
 interface TemplateNameParserInterface
 {
diff --git a/src/Symfony/Component/Templating/TemplateReference.php b/src/Symfony/Component/Templating/TemplateReference.php
@@ -11,10 +11,14 @@
 
 namespace Symfony\Component\Templating;
 
+trigger_deprecation('symfony/templating', '6.4', '"%s" is deprecated since version 6.4 and will be removed in 7.0. Use Twig instead.', TemplateReference::class);
+
 /**
  * Internal representation of a template.
  *
  * @author Victor Berchet <victor@suumit.com>
+ *
+ * @deprecated since Symfony 6.4, use Twig instead
  */
 class TemplateReference implements TemplateReferenceInterface
 {
diff --git a/src/Symfony/Component/Templating/TemplateReferenceInterface.php b/src/Symfony/Component/Templating/TemplateReferenceInterface.php
@@ -11,10 +11,14 @@
 
 namespace Symfony\Component\Templating;
 
+trigger_deprecation('symfony/templating', '6.4', '"%s" is deprecated since version 6.4 and will be removed in 7.0. Use Twig instead.', TemplateReferenceInterface::class);
+
 /**
  * Interface to be implemented by all templates.
  *
  * @author Victor Berchet <victor@suumit.com>
+ *
+ * @deprecated since Symfony 6.4, use Twig instead
  */
 interface TemplateReferenceInterface
 {
diff --git a/src/Symfony/Component/Templating/Tests/DelegatingEngineTest.php b/src/Symfony/Component/Templating/Tests/DelegatingEngineTest.php
@@ -16,6 +16,9 @@
 use Symfony\Component\Templating\EngineInterface;
 use Symfony\Component\Templating\StreamingEngineInterface;
 
+/**
+ * @group legacy
+ */
 class DelegatingEngineTest extends TestCase
 {
     public function testRenderDelegatesToSupportedEngine()
diff --git a/src/Symfony/Component/Templating/Tests/Helper/HelperTest.php b/src/Symfony/Component/Templating/Tests/Helper/HelperTest.php
@@ -14,6 +14,9 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Templating\Helper\Helper;
 
+/**
+ * @group legacy
+ */
 class HelperTest extends TestCase
 {
     public function testGetSetCharset()
diff --git a/src/Symfony/Component/Templating/Tests/Helper/SlotsHelperTest.php b/src/Symfony/Component/Templating/Tests/Helper/SlotsHelperTest.php
@@ -14,6 +14,9 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Templating\Helper\SlotsHelper;
 
+/**
+ * @group legacy
+ */
 class SlotsHelperTest extends TestCase
 {
     public function testHasGetSet()
diff --git a/src/Symfony/Component/Templating/Tests/Loader/CacheLoaderTest.php b/src/Symfony/Component/Templating/Tests/Loader/CacheLoaderTest.php
@@ -20,6 +20,9 @@
 use Symfony\Component\Templating\TemplateReference;
 use Symfony\Component\Templating\TemplateReferenceInterface;
 
+/**
+ * @group legacy
+ */
 class CacheLoaderTest extends TestCase
 {
     public function testConstructor()
diff --git a/src/Symfony/Component/Templating/Tests/Loader/ChainLoaderTest.php b/src/Symfony/Component/Templating/Tests/Loader/ChainLoaderTest.php
@@ -16,6 +16,9 @@
 use Symfony\Component\Templating\Loader\FilesystemLoader;
 use Symfony\Component\Templating\TemplateReference;
 
+/**
+ * @group legacy
+ */
 class ChainLoaderTest extends TestCase
 {
     protected FilesystemLoader $loader1;
diff --git a/src/Symfony/Component/Templating/Tests/Loader/FilesystemLoaderTest.php b/src/Symfony/Component/Templating/Tests/Loader/FilesystemLoaderTest.php
@@ -17,6 +17,9 @@
 use Symfony\Component\Templating\Storage\FileStorage;
 use Symfony\Component\Templating\TemplateReference;
 
+/**
+ * @group legacy
+ */
 class FilesystemLoaderTest extends TestCase
 {
     protected static string $fixturesPath;
diff --git a/src/Symfony/Component/Templating/Tests/Loader/LoaderTest.php b/src/Symfony/Component/Templating/Tests/Loader/LoaderTest.php
@@ -17,6 +17,9 @@
 use Symfony\Component\Templating\Storage\Storage;
 use Symfony\Component\Templating\TemplateReferenceInterface;
 
+/**
+ * @group legacy
+ */
 class LoaderTest extends TestCase
 {
     public function testGetSetLogger()
diff --git a/src/Symfony/Component/Templating/Tests/PhpEngineTest.php b/src/Symfony/Component/Templating/Tests/PhpEngineTest.php
diff --git a/src/Symfony/Component/Templating/Tests/Storage/FileStorageTest.php b/src/Symfony/Component/Templating/Tests/Storage/FileStorageTest.php
diff --git a/src/Symfony/Component/Templating/Tests/Storage/StorageTest.php b/src/Symfony/Component/Templating/Tests/Storage/StorageTest.php
diff --git a/src/Symfony/Component/Templating/Tests/Storage/StringStorageTest.php b/src/Symfony/Component/Templating/Tests/Storage/StringStorageTest.php
diff --git a/src/Symfony/Component/Templating/Tests/TemplateNameParserTest.php b/src/Symfony/Component/Templating/Tests/TemplateNameParserTest.php
diff --git a/src/Symfony/Component/Templating/composer.json b/src/Symfony/Component/Templating/composer.json

Original file line number	Diff line number	Diff line change
`@@ -11,10 +11,14 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\Templating;`
`13`	`13`
	`14`	`+trigger_deprecation('symfony/templating', '6.4', '"%s" is deprecated since version 6.4 and will be removed in 7.0. Use Twig instead.', DelegatingEngine::class);`
	`15`	`+`
`14`	`16`	`/**`
`15`	`17`	`* DelegatingEngine selects an engine for a given template.`
`16`	`18`	`*`
`17`	`19`	`* @author Fabien Potencier <fabien@symfony.com>`
	`20`	`+ *`
	`21`	`+ * @deprecated since Symfony 6.4, use Twig instead`
`18`	`22`	`*/`
`19`	`23`	`class DelegatingEngine implements EngineInterface, StreamingEngineInterface`
`20`	`24`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,8 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\Templating;`
`13`	`13`
	`14`	`+trigger_deprecation('symfony/templating', '6.4', '"%s" is deprecated since version 6.4 and will be removed in 7.0. Use Twig instead.', EngineInterface::class);`
	`15`	`+`
`14`	`16`	`/**`
`15`	`17`	`* EngineInterface is the interface each engine must implement.`
`16`	`18`	`*`
`@@ -27,6 +29,8 @@`
`27`	`29`	`* the template.`
`28`	`30`	`*`
`29`	`31`	`* @author Fabien Potencier <fabien@symfony.com>`
	`32`	`+ *`
	`33`	`+ * @deprecated since Symfony 6.4, use Twig instead`
`30`	`34`	`*/`
`31`	`35`	`interface EngineInterface`
`32`	`36`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,13 +11,17 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\Templating\Helper;`
`13`	`13`
	`14`	`+trigger_deprecation('symfony/templating', '6.4', '"%s" is deprecated since version 6.4 and will be removed in 7.0. Use Twig instead.', Helper::class);`
	`15`	`+`
`14`	`16`	`/**`
`15`	`17`	`* Helper is the base class for all helper classes.`
`16`	`18`	`*`
`17`	`19`	`* Most of the time, a Helper is an adapter around an existing`
`18`	`20`	`* class that exposes a read-only interface for templates.`
`19`	`21`	`*`
`20`	`22`	`* @author Fabien Potencier <fabien@symfony.com>`
	`23`	`+ *`
	`24`	`+ * @deprecated since Symfony 6.4, use Twig instead`
`21`	`25`	`*/`
`22`	`26`	`abstract class Helper implements HelperInterface`
`23`	`27`	`{`
Original file line number	Diff line number	Diff line change
`@@ -14,10 +14,14 @@`
`14`	`14`	`use Symfony\Component\Templating\Storage\Storage;`
`15`	`15`	`use Symfony\Component\Templating\TemplateReferenceInterface;`
`16`	`16`
	`17`	`+trigger_deprecation('symfony/templating', '6.4', '"%s" is deprecated since version 6.4 and will be removed in 7.0. Use Twig instead.', ChainLoader::class);`
	`18`	`+`
`17`	`19`	`/**`
`18`	`20`	`* ChainLoader is a loader that calls other loaders to load templates.`
`19`	`21`	`*`
`20`	`22`	`* @author Fabien Potencier <fabien@symfony.com>`
	`23`	`+ *`
	`24`	`+ * @deprecated since Symfony 6.4, use Twig instead`
`21`	`25`	`*/`
`22`	`26`	`class ChainLoader extends Loader`
`23`	`27`	`{`
Original file line number	Diff line number	Diff line change
`@@ -15,10 +15,14 @@`
`15`	`15`	`use Symfony\Component\Templating\Storage\Storage;`
`16`	`16`	`use Symfony\Component\Templating\TemplateReferenceInterface;`
`17`	`17`
	`18`	`+trigger_deprecation('symfony/templating', '6.4', '"%s" is deprecated since version 6.4 and will be removed in 7.0. Use Twig instead.', FilesystemLoader::class);`
	`19`	`+`
`18`	`20`	`/**`
`19`	`21`	`* FilesystemLoader is a loader that read templates from the filesystem.`
`20`	`22`	`*`
`21`	`23`	`* @author Fabien Potencier <fabien@symfony.com>`
	`24`	`+ *`
	`25`	`+ * @deprecated since Symfony 6.4, use Twig instead`
`22`	`26`	`*/`
`23`	`27`	`class FilesystemLoader extends Loader`
`24`	`28`	`{`