[Console][#18619] Prevent fatal error when calling Command#getHelper() without helperSet

chalasr · chalasr · commit ede4d92713c2 · 2016-05-02T17:28:13.000+02:00
Use Command::setHelperSet rather than Command#setHelperSet in exception msg

Simplify exception message

Add DidYouForget to exception msg
diff --git a/src/Symfony/Component/Console/Command/Command.php b/src/Symfony/Component/Console/Command/Command.php
@@ -601,10 +601,15 @@ public function getUsages()
      *
      * @return mixed The helper value
      *
-     * @throws InvalidArgumentException if the helper is not defined
+     * @throws LogicException           If no HelperSet is defined
+     * @throws InvalidArgumentException If the helper is not defined
      */
     public function getHelper($name)
     {
+        if (null === $this->helperSet) {
+            throw new LogicException(sprintf('Cannot retrieve helper "%s" because there is no HelperSet defined. Did you forget to add your command to the application or to set the application on the command using the setApplication() method? You can also set the HelperSet directly using the setHelperSet() method.', $name));
+        }
+
         return $this->helperSet->get($name);
     }
 
diff --git a/src/Symfony/Component/Console/Tests/Command/CommandTest.php b/src/Symfony/Component/Console/Tests/Command/CommandTest.php
@@ -173,6 +173,16 @@ public function testGetHelper()
         $this->assertEquals($formatterHelper->getName(), $command->getHelper('formatter')->getName(), '->getHelper() returns the correct helper');
     }
 
+    /**
+     * @expectedException        \LogicException
+     * @expectedExceptionMessage Cannot retrieve helper "formatter" because there is no HelperSet defined.
+     */
+    public function testGetHelperWithoutHelperSet()
+    {
+        $command = new \TestCommand();
+        $command->getHelper('formatter');
+    }
+
     public function testMergeApplicationDefinition()
     {
         $application1 = new Application();

Original file line number	Diff line number	Diff line change
`@@ -601,10 +601,15 @@ public function getUsages()`
`601`	`601`	`*`
`602`	`602`	`* @return mixed The helper value`
`603`	`603`	`*`
`604`		`- * @throws InvalidArgumentException if the helper is not defined`
	`604`	`+ * @throws LogicException If no HelperSet is defined`
	`605`	`+ * @throws InvalidArgumentException If the helper is not defined`
`605`	`606`	`*/`
`606`	`607`	`public function getHelper($name)`
`607`	`608`	`{`
	`609`	`+ if (null === $this->helperSet) {`
	`610`	`+ throw new LogicException(sprintf('Cannot retrieve helper "%s" because there is no HelperSet defined. Did you forget to add your command to the application or to set the application on the command using the setApplication() method? You can also set the HelperSet directly using the setHelperSet() method.', $name));`
	`611`	`+ }`
	`612`	`+`
`608`	`613`	`return $this->helperSet->get($name);`
`609`	`614`	`}`
`610`	`615`