feature #23035 [3.4] Deprecate passing a concrete service in optional cache warmers (romainneutron)

nicolas-grekas · nicolas-grekas · commit 9d24e80b0049 · 2017-06-03T10:55:18.000+02:00
This PR was merged into the 3.4 branch. Discussion ---------- [3.4] Deprecate passing a concrete service in optional cache warmers | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | no | New feature? | no  | BC breaks? | no | Deprecations? | yes  | Tests pass? | yes | Fixed tickets | N/A | License | MIT Commits ------- b9c91cd Deprecate passing a concrete service in optional cache warmers
diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/RouterCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/RouterCacheWarmer.php
@@ -19,6 +19,8 @@
  * Generates the router matcher and generator classes.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since version 3.4, to be given a container instead in 4.0
  */
 class RouterCacheWarmer implements CacheWarmerInterface
 {
diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/TranslationsCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/TranslationsCacheWarmer.php
@@ -30,7 +30,7 @@ class TranslationsCacheWarmer implements CacheWarmerInterface, ServiceSubscriber
     /**
      * TranslationsCacheWarmer constructor.
      *
-     * @param ContainerInterface|TranslatorInterface $container
+     * @param ContainerInterface $container
      */
     public function __construct($container)
     {
@@ -39,6 +39,7 @@ public function __construct($container)
             $this->container = $container;
         } elseif ($container instanceof TranslatorInterface) {
             $this->translator = $container;
+            @trigger_error(sprintf('Using a "%s" as first argument of %s is deprecated since version 3.4 and will be unsupported in version 4.0. Use a %s instead.', TranslatorInterface::class, __CLASS__, ContainerInterface::class), E_USER_DEPRECATED);
         } else {
             throw new \InvalidArgumentException(sprintf('%s only accepts instance of Psr\Container\ContainerInterface as first argument.', __CLASS__));
         }
diff --git a/src/Symfony/Bundle/TwigBundle/CacheWarmer/TemplateCacheWarmer.php b/src/Symfony/Bundle/TwigBundle/CacheWarmer/TemplateCacheWarmer.php
@@ -31,8 +31,8 @@ class TemplateCacheWarmer implements CacheWarmerInterface, ServiceSubscriberInte
     /**
      * TemplateCacheWarmer constructor.
      *
-     * @param ContainerInterface|Environment $container
-     * @param \Traversable                   $iterator
+     * @param ContainerInterface $container
+     * @param \Traversable       $iterator
      */
     public function __construct($container, \Traversable $iterator)
     {
@@ -41,6 +41,7 @@ public function __construct($container, \Traversable $iterator)
             $this->container = $container;
         } elseif ($container instanceof Environment) {
             $this->twig = $container;
+            @trigger_error(sprintf('Using a "%s" as first argument of %s is deprecated since version 3.4 and will be unsupported in version 4.0. Use a %s instead.', Environment::class, __CLASS__, Container::class), E_USER_DEPRECATED);
         } else {
             throw new \InvalidArgumentException(sprintf('%s only accepts instance of Psr\Container\ContainerInterface as first argument.', __CLASS__));
         }

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,8 @@`
`19`	`19`	`* Generates the router matcher and generator classes.`
`20`	`20`	`*`
`21`	`21`	`* @author Fabien Potencier <fabien@symfony.com>`
	`22`	`+ *`
	`23`	`+ * @final since version 3.4, to be given a container instead in 4.0`
`22`	`24`	`*/`
`23`	`25`	`class RouterCacheWarmer implements CacheWarmerInterface`
`24`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ class TranslationsCacheWarmer implements CacheWarmerInterface, ServiceSubscriber`
`30`	`30`	`/**`
`31`	`31`	`* TranslationsCacheWarmer constructor.`
`32`	`32`	`*`
`33`		`- * @param ContainerInterface\|TranslatorInterface $container`
	`33`	`+ * @param ContainerInterface $container`
`34`	`34`	`*/`
`35`	`35`	`public function __construct($container)`
`36`	`36`	`{`
`@@ -39,6 +39,7 @@ public function __construct($container)`
`39`	`39`	`$this->container = $container;`
`40`	`40`	`} elseif ($container instanceof TranslatorInterface) {`
`41`	`41`	`$this->translator = $container;`
	`42`	`+ @trigger_error(sprintf('Using a "%s" as first argument of %s is deprecated since version 3.4 and will be unsupported in version 4.0. Use a %s instead.', TranslatorInterface::class, __CLASS__, ContainerInterface::class), E_USER_DEPRECATED);`
`42`	`43`	`} else {`
`43`	`44`	`throw new \InvalidArgumentException(sprintf('%s only accepts instance of Psr\Container\ContainerInterface as first argument.', __CLASS__));`
`44`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,8 +31,8 @@ class TemplateCacheWarmer implements CacheWarmerInterface, ServiceSubscriberInte`
`31`	`31`	`/**`
`32`	`32`	`* TemplateCacheWarmer constructor.`
`33`	`33`	`*`
`34`		`- * @param ContainerInterface\|Environment $container`
`35`		`- * @param \Traversable $iterator`
	`34`	`+ * @param ContainerInterface $container`
	`35`	`+ * @param \Traversable $iterator`
`36`	`36`	`*/`
`37`	`37`	`public function __construct($container, \Traversable $iterator)`
`38`	`38`	`{`
`@@ -41,6 +41,7 @@ public function __construct($container, \Traversable $iterator)`
`41`	`41`	`$this->container = $container;`
`42`	`42`	`} elseif ($container instanceof Environment) {`
`43`	`43`	`$this->twig = $container;`
	`44`	`+ @trigger_error(sprintf('Using a "%s" as first argument of %s is deprecated since version 3.4 and will be unsupported in version 4.0. Use a %s instead.', Environment::class, __CLASS__, Container::class), E_USER_DEPRECATED);`
`44`	`45`	`} else {`
`45`	`46`	`throw new \InvalidArgumentException(sprintf('%s only accepts instance of Psr\Container\ContainerInterface as first argument.', __CLASS__));`
`46`	`47`	`}`