[Console] Deprecate HelperSet::setCommand() and getCommand()

derrabus · derrabus · commit 60bff9bc0b5b · 2021-08-18T23:02:44.000+02:00
diff --git a/UPGRADE-5.4.md b/UPGRADE-5.4.md
@@ -6,6 +6,11 @@ Cache
 
  * Deprecate `DoctrineProvider` because this class has been added to the `doctrine/cache` package`
 
+Console
+-------
+
+ * Deprecate `HelperSet::setCommand()` and `getCommand()` without replacement
+
 Finder
 ------
 
diff --git a/UPGRADE-6.0.md b/UPGRADE-6.0.md
@@ -30,6 +30,7 @@ Console
  * `Command::setHidden()` has a default value (`true`) for `$hidden` parameter
  * Remove `Helper::strlen()`, use `Helper::width()` instead.
  * Remove `Helper::strlenWithoutDecoration()`, use `Helper::removeDecoration()` instead.
+ * Remove `HelperSet::setCommand()` and `getCommand()` without replacement
 
 DependencyInjection
 -------------------
diff --git a/src/Symfony/Component/Console/CHANGELOG.md b/src/Symfony/Component/Console/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Add `TesterTrait::assertCommandIsSuccessful()` to test command
+ * Deprecate `HelperSet::setCommand()` and `getCommand()` without replacement
 
 5.3
 ---
diff --git a/src/Symfony/Component/Console/Helper/HelperSet.php b/src/Symfony/Component/Console/Helper/HelperSet.php
@@ -73,18 +73,27 @@ public function get(string $name)
         return $this->helpers[$name];
     }
 
+    /**
+     * @deprecated since Symfony 5.4
+     */
     public function setCommand(Command $command = null)
     {
+        trigger_deprecation('symfony/console', '5.4', 'Method "%s()" is deprecated.', __METHOD__);
+
         $this->command = $command;
     }
 
     /**
      * Gets the command associated with this helper set.
      *
      * @return Command
+     *
+     * @deprecated since Symfony 5.4
      */
     public function getCommand()
     {
+        trigger_deprecation('symfony/console', '5.4', 'Method "%s()" is deprecated.', __METHOD__);
+
         return $this->command;
     }
 
diff --git a/src/Symfony/Component/Console/Tests/Helper/HelperSetTest.php b/src/Symfony/Component/Console/Tests/Helper/HelperSetTest.php
@@ -74,6 +74,9 @@ public function testGet()
         }
     }
 
+    /**
+     * @group legacy
+     */
     public function testSetCommand()
     {
         $cmd_01 = new Command('foo');
@@ -89,6 +92,9 @@ public function testSetCommand()
         $this->assertEquals($cmd_02, $helperset->getCommand(), '->setCommand() overwrites stored command with consecutive calls');
     }
 
+    /**
+     * @group legacy
+     */
     public function testGetCommand()
     {
         $cmd = new Command('foo');

Original file line number	Diff line number	Diff line change
`@@ -73,18 +73,27 @@ public function get(string $name)`
`73`	`73`	`return $this->helpers[$name];`
`74`	`74`	`}`
`75`	`75`
	`76`	`+ /**`
	`77`	`+ * @deprecated since Symfony 5.4`
	`78`	`+ */`
`76`	`79`	`public function setCommand(Command $command = null)`
`77`	`80`	`{`
	`81`	`+ trigger_deprecation('symfony/console', '5.4', 'Method "%s()" is deprecated.', __METHOD__);`
	`82`	`+`
`78`	`83`	`$this->command = $command;`
`79`	`84`	`}`
`80`	`85`
`81`	`86`	`/**`
`82`	`87`	`* Gets the command associated with this helper set.`
`83`	`88`	`*`
`84`	`89`	`* @return Command`
	`90`	`+ *`
	`91`	`+ * @deprecated since Symfony 5.4`
`85`	`92`	`*/`
`86`	`93`	`public function getCommand()`
`87`	`94`	`{`
	`95`	`+ trigger_deprecation('symfony/console', '5.4', 'Method "%s()" is deprecated.', __METHOD__);`
	`96`	`+`
`88`	`97`	`return $this->command;`
`89`	`98`	`}`
`90`	`99`
Original file line number	Diff line number	Diff line change
`@@ -74,6 +74,9 @@ public function testGet()`
`74`	`74`	`}`
`75`	`75`	`}`
`76`	`76`
	`77`	`+ /**`
	`78`	`+ * @group legacy`
	`79`	`+ */`
`77`	`80`	`public function testSetCommand()`
`78`	`81`	`{`
`79`	`82`	`$cmd_01 = new Command('foo');`
`@@ -89,6 +92,9 @@ public function testSetCommand()`
`89`	`92`	`$this->assertEquals($cmd_02, $helperset->getCommand(), '->setCommand() overwrites stored command with consecutive calls');`
`90`	`93`	`}`
`91`	`94`
	`95`	`+ /**`
	`96`	`+ * @group legacy`
	`97`	`+ */`
`92`	`98`	`public function testGetCommand()`
`93`	`99`	`{`
`94`	`100`	`$cmd = new Command('foo');`