Deprecate passing a concrete service in optional cache warmers

romainneutron · romainneutron · commit cc3c08d02130 · 2017-06-02T16:23:22.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/TranslationsCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/TranslationsCacheWarmer.php
@@ -20,6 +20,8 @@
  * Generates the catalogues for translations.
  *
  * @author Xavier Leune <xavier.leune@gmail.com>
+ *
+ * @final since version 3.4, to be given a container instead in 4.0
  */
 class TranslationsCacheWarmer implements CacheWarmerInterface
 {
@@ -29,7 +31,7 @@ class TranslationsCacheWarmer implements CacheWarmerInterface
     /**
      * TranslationsCacheWarmer constructor.
      *
-     * @param ContainerInterface|TranslatorInterface $container
+     * @param ContainerInterface $container
      */
     public function __construct($container)
     {
@@ -38,8 +40,9 @@ 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 Symfony\Component\DependencyInjection\ContainerInterface or Symfony\Component\Translation\TranslatorInterface as first argument.', __CLASS__));
+            throw new \InvalidArgumentException(sprintf('%s only accepts instance of Symfony\Component\DependencyInjection\ContainerInterface as first argument.', __CLASS__));
         }
     }
 
diff --git a/src/Symfony/Bundle/TwigBundle/CacheWarmer/TemplateCacheWarmer.php b/src/Symfony/Bundle/TwigBundle/CacheWarmer/TemplateCacheWarmer.php
@@ -20,6 +20,8 @@
  * Generates the Twig cache for all templates.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since version 3.4, to be given a container instead in 4.0
  */
 class TemplateCacheWarmer implements CacheWarmerInterface
 {
@@ -30,8 +32,8 @@ class TemplateCacheWarmer implements CacheWarmerInterface
     /**
      * TemplateCacheWarmer constructor.
      *
-     * @param ContainerInterface|Environment $container
-     * @param \Traversable                   $iterator
+     * @param ContainerInterface $container
+     * @param \Traversable       $iterator
      */
     public function __construct($container, \Traversable $iterator)
     {
@@ -40,8 +42,9 @@ 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 Symfony\Component\DependencyInjection\ContainerInterface or Environment as first argument.', __CLASS__));
+            throw new \InvalidArgumentException(sprintf('%s only accepts instance of Symfony\Component\DependencyInjection\ContainerInterface as first argument.', __CLASS__));
         }
 
         $this->iterator = $iterator;

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,8 @@`
`20`	`20`	`* Generates the catalogues for translations.`
`21`	`21`	`*`
`22`	`22`	`* @author Xavier Leune <xavier.leune@gmail.com>`
	`23`	`+ *`
	`24`	`+ * @final since version 3.4, to be given a container instead in 4.0`
`23`	`25`	`*/`
`24`	`26`	`class TranslationsCacheWarmer implements CacheWarmerInterface`
`25`	`27`	`{`
`@@ -29,7 +31,7 @@ class TranslationsCacheWarmer implements CacheWarmerInterface`
`29`	`31`	`/**`
`30`	`32`	`* TranslationsCacheWarmer constructor.`
`31`	`33`	`*`
`32`		`- * @param ContainerInterface\|TranslatorInterface $container`
	`34`	`+ * @param ContainerInterface $container`
`33`	`35`	`*/`
`34`	`36`	`public function __construct($container)`
`35`	`37`	`{`
`@@ -38,8 +40,9 @@ public function __construct($container)`
`38`	`40`	`$this->container = $container;`
`39`	`41`	`} elseif ($container instanceof TranslatorInterface) {`
`40`	`42`	`$this->translator = $container;`
	`43`	`+ @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);`
`41`	`44`	`} else {`
`42`		`- throw new \InvalidArgumentException(sprintf('%s only accepts instance of Symfony\Component\DependencyInjection\ContainerInterface or Symfony\Component\Translation\TranslatorInterface as first argument.', __CLASS__));`
	`45`	`+ throw new \InvalidArgumentException(sprintf('%s only accepts instance of Symfony\Component\DependencyInjection\ContainerInterface as first argument.', __CLASS__));`
`43`	`46`	`}`
`44`	`47`	`}`
`45`	`48`