bug #18635 [Console] Prevent fatal error when calling Command::getHelper without helperSet (chalasr)

fabpot · fabpot · commit f999e7720290 · 2016-05-13T10:18:57.000-05:00
This PR was submitted for the master branch but it was merged into the 2.3 branch instead (closes #18635). Discussion ---------- [Console] Prevent fatal error when calling Command::getHelper without helperSet | Q | A | ------------- | --- | Branch? | master | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #18619 | License | MIT | Doc PR | n/a Patch attached to #18619 Commits ------- 31285c2 [Console][#18619] Prevent fatal error when calling Command#getHelper() without helperSet
diff --git a/src/Symfony/Component/Console/Command/Command.php b/src/Symfony/Component/Console/Command/Command.php
@@ -537,10 +537,15 @@ public function getSynopsis()
      *
      * @return mixed The helper value
      *
+     * @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
`@@ -537,10 +537,15 @@ public function getSynopsis()`
`537`	`537`	`*`
`538`	`538`	`* @return mixed The helper value`
`539`	`539`	`*`
	`540`	`+ * @throws \LogicException if no HelperSet is defined`
`540`	`541`	`* @throws \InvalidArgumentException if the helper is not defined`
`541`	`542`	`*/`
`542`	`543`	`public function getHelper($name)`
`543`	`544`	`{`
	`545`	`+ if (null === $this->helperSet) {`
	`546`	`+ 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));`
	`547`	`+ }`
	`548`	`+`
`544`	`549`	`return $this->helperSet->get($name);`
`545`	`550`	`}`
`546`	`551`