mark classes implementing the WarmableInterface as final

xabbuh · xabbuh · commit d5e55b35a030 · 2023-12-20T08:12:55.000+01:00
diff --git a/UPGRADE-7.1.md b/UPGRADE-7.1.md
@@ -6,11 +6,31 @@ Cache
 
  * Deprecate `CouchbaseBucketAdapter`, use `CouchbaseCollectionAdapter` instead
 
+FrameworkBundle
+---------------
+
+ * Mark classes `ConfigBuilderCacheWarmer`, `Router`, `SerializerCacheWarmer`, `TranslationsCacheWarmer`, `Translator` and `ValidatorCacheWarmer` as `final`
+
 Messenger
 ---------
 
  * Make `#[AsMessageHandler]` final
 
+SecurityBundle
+--------------
+
+ * Mark class `ExpressionCacheWarmer` as `final`
+
+Translation
+-----------
+
+ * Mark class `DataCollectorTranslator` as `final`
+
+TwigBundle
+----------
+
+ * Mark class `TemplateCacheWarmer` as `final`
+
 Workflow
 --------
 
diff --git a/src/Symfony/Bridge/Doctrine/CacheWarmer/ProxyCacheWarmer.php b/src/Symfony/Bridge/Doctrine/CacheWarmer/ProxyCacheWarmer.php
@@ -21,6 +21,8 @@
  * since this information is necessary to build the proxies in the first place.
  *
  * @author Benjamin Eberlei <kontakt@beberlei.de>
+ *
+ * @final since Symfony 7.1
  */
 class ProxyCacheWarmer implements CacheWarmerInterface
 {
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -4,6 +4,7 @@ CHANGELOG
 7.1
 ---
 
+ * Mark classes `ConfigBuilderCacheWarmer`, `Router`, `SerializerCacheWarmer`, `TranslationsCacheWarmer`, `Translator` and `ValidatorCacheWarmer` as `final`
  * Move the Router `cache_dir` to `kernel.build_dir`
  * Deprecate the `router.cache_dir` config option
  * Add `rate_limiter` tags to rate limiter services
diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/AbstractPhpFileCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/AbstractPhpFileCacheWarmer.php
@@ -17,6 +17,9 @@
 use Symfony\Component\Config\Resource\ClassExistenceResource;
 use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;
 
+/**
+ * @internal since Symfony 7.1
+ */
 abstract class AbstractPhpFileCacheWarmer implements CacheWarmerInterface
 {
     private string $phpArrayFile;
diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/ConfigBuilderCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/ConfigBuilderCacheWarmer.php
@@ -25,6 +25,8 @@
  * Generate all config builders.
  *
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ *
+ * @final since Symfony 7.1
  */
 class ConfigBuilderCacheWarmer implements CacheWarmerInterface
 {
diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/SerializerCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/SerializerCacheWarmer.php
@@ -23,6 +23,8 @@
  * Warms up XML and YAML serializer metadata.
  *
  * @author Titouan Galopin <galopintitouan@gmail.com>
+ *
+ * @final since Symfony 7.1
  */
 class SerializerCacheWarmer extends AbstractPhpFileCacheWarmer
 {
diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/TranslationsCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/TranslationsCacheWarmer.php
@@ -21,6 +21,8 @@
  * Generates the catalogues for translations.
  *
  * @author Xavier Leune <xavier.leune@gmail.com>
+ *
+ * @final since Symfony 7.1
  */
 class TranslationsCacheWarmer implements CacheWarmerInterface, ServiceSubscriberInterface
 {
diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/ValidatorCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/ValidatorCacheWarmer.php
@@ -24,6 +24,8 @@
  * Warms up XML and YAML validator metadata.
  *
  * @author Titouan Galopin <galopintitouan@gmail.com>
+ *
+ * @final since Symfony 7.1
  */
 class ValidatorCacheWarmer extends AbstractPhpFileCacheWarmer
 {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Routing/Router.php b/src/Symfony/Bundle/FrameworkBundle/Routing/Router.php
@@ -30,6 +30,8 @@
  * This Router creates the Loader only when the cache is empty.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since Symfony 7.1
  */
 class Router extends BaseRouter implements WarmableInterface, ServiceSubscriberInterface
 {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Translation/Translator.php b/src/Symfony/Bundle/FrameworkBundle/Translation/Translator.php
@@ -21,6 +21,8 @@
 
 /**
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since Symfony 7.1
  */
 class Translator extends BaseTranslator implements WarmableInterface
 {
diff --git a/src/Symfony/Bundle/SecurityBundle/CHANGELOG.md b/src/Symfony/Bundle/SecurityBundle/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+7.1
+---
+
+ * Mark class `ExpressionCacheWarmer` as `final`
+
 7.0
 ---
 
diff --git a/src/Symfony/Bundle/SecurityBundle/CacheWarmer/ExpressionCacheWarmer.php b/src/Symfony/Bundle/SecurityBundle/CacheWarmer/ExpressionCacheWarmer.php
@@ -15,6 +15,9 @@
 use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;
 use Symfony\Component\Security\Core\Authorization\ExpressionLanguage;
 
+/**
+ * @final since Symfony 7.1
+ */
 class ExpressionCacheWarmer implements CacheWarmerInterface
 {
     private iterable $expressions;
diff --git a/src/Symfony/Bundle/TwigBundle/CHANGELOG.md b/src/Symfony/Bundle/TwigBundle/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+7.1
+---
+
+ * Mark class `TemplateCacheWarmer` as `final`
+
 7.0
 ---
 
diff --git a/src/Symfony/Bundle/TwigBundle/CacheWarmer/TemplateCacheWarmer.php b/src/Symfony/Bundle/TwigBundle/CacheWarmer/TemplateCacheWarmer.php
@@ -21,6 +21,8 @@
  * Generates the Twig cache for all templates.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since Symfony 7.1
  */
 class TemplateCacheWarmer implements CacheWarmerInterface, ServiceSubscriberInterface
 {
diff --git a/src/Symfony/Component/Translation/CHANGELOG.md b/src/Symfony/Component/Translation/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+7.1
+---
+
+ * Mark class `DataCollectorTranslator` as `final`
+
 7.0
 ---
 
diff --git a/src/Symfony/Component/Translation/DataCollectorTranslator.php b/src/Symfony/Component/Translation/DataCollectorTranslator.php
@@ -18,6 +18,8 @@
 
 /**
  * @author Abdellatif Ait boudad <a.aitboudad@gmail.com>
+ *
+ * @final since Symfony 7.1
  */
 class DataCollectorTranslator implements TranslatorInterface, TranslatorBagInterface, LocaleAwareInterface, WarmableInterface
 {

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,8 @@`
`21`	`21`	`* since this information is necessary to build the proxies in the first place.`
`22`	`22`	`*`
`23`	`23`	`* @author Benjamin Eberlei <[email protected]>`
	`24`	`+ *`
	`25`	`+ * @final since Symfony 7.1`
`24`	`26`	`*/`
`25`	`27`	`class ProxyCacheWarmer implements CacheWarmerInterface`
`26`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,9 @@`
`17`	`17`	`use Symfony\Component\Config\Resource\ClassExistenceResource;`
`18`	`18`	`use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;`
`19`	`19`
	`20`	`+/**`
	`21`	`+ * @internal since Symfony 7.1`
	`22`	`+ */`
`20`	`23`	`abstract class AbstractPhpFileCacheWarmer implements CacheWarmerInterface`
`21`	`24`	`{`
`22`	`25`	`private string $phpArrayFile;`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,8 @@`
`25`	`25`	`* Generate all config builders.`
`26`	`26`	`*`
`27`	`27`	`* @author Tobias Nyholm <[email protected]>`
	`28`	`+ *`
	`29`	`+ * @final since Symfony 7.1`
`28`	`30`	`*/`
`29`	`31`	`class ConfigBuilderCacheWarmer implements CacheWarmerInterface`
`30`	`32`	`{`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,8 @@`
`23`	`23`	`* Warms up XML and YAML serializer metadata.`
`24`	`24`	`*`
`25`	`25`	`* @author Titouan Galopin <[email protected]>`
	`26`	`+ *`
	`27`	`+ * @final since Symfony 7.1`
`26`	`28`	`*/`
`27`	`29`	`class SerializerCacheWarmer extends AbstractPhpFileCacheWarmer`
`28`	`30`	`{`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,8 @@`
`24`	`24`	`* Warms up XML and YAML validator metadata.`
`25`	`25`	`*`
`26`	`26`	`* @author Titouan Galopin <[email protected]>`
	`27`	`+ *`
	`28`	`+ * @final since Symfony 7.1`
`27`	`29`	`*/`
`28`	`30`	`class ValidatorCacheWarmer extends AbstractPhpFileCacheWarmer`
`29`	`31`	`{`
Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,8 @@`
`30`	`30`	`* This Router creates the Loader only when the cache is empty.`
`31`	`31`	`*`
`32`	`32`	`* @author Fabien Potencier <[email protected]>`
	`33`	`+ *`
	`34`	`+ * @final since Symfony 7.1`
`33`	`35`	`*/`
`34`	`36`	`class Router extends BaseRouter implements WarmableInterface, ServiceSubscriberInterface`
`35`	`37`	`{`