minor #42537 [Form] Fix return types in form builder (Tobion)

nicolas-grekas · nicolas-grekas · commit b1115f9f71b0 · 2021-08-16T16:09:52.000+02:00
This PR was merged into the 5.4 branch. Discussion ---------- [Form] Fix return types in form builder | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | no  | Deprecations? | no  | Tickets | | License | MIT | Doc PR | Fix return types incompatibilities found by psalm in #42511 > Error: The declared return type 'Symfony\Component\EventDispatcher\EventDispatcherInterface' for Symfony\Component\Form\ButtonBuilder::getEventDispatcher is not nullable, but 'null' contains null (see https://psalm.dev/144) Error: The declared return type 'string' for Symfony\Component\Form\ButtonBuilder::getAction is not nullable, but 'null' contains null (see https://psalm.dev/144) Error: The declared return type 'string' for Symfony\Component\Form\ButtonBuilder::getMethod is not nullable, but 'null' contains null (see https://psalm.dev/144) Error: The declared return type 'Symfony\Component\Form\RequestHandlerInterface' for Symfony\Component\Form\ButtonBuilder::getRequestHandler is not nullable, but 'null' contains null (see https://psalm.dev/144) Error: The declared return type 'Symfony\Component\Form\FormFactoryInterface' for Symfony\Component\Form\FormConfigBuilder::getFormFactory is not nullable, but 'Symfony\Component\Form\FormFactoryInterface|null' contains null (see https://psalm.dev/144) Error: The declared return type 'string' for Symfony\Component\Form\FormConfigBuilder::getAction is not nullable, but 'null|string' contains null (see https://psalm.dev/144) Commits ------- ea606ea [Form] Fix return types in form builder
diff --git a/src/Symfony/Component/Form/ButtonBuilder.php b/src/Symfony/Component/Form/ButtonBuilder.php
@@ -430,10 +430,12 @@ public function setIsEmptyCallback(?callable $isEmptyCallback)
 
     /**
      * Unsupported method.
+     *
+     * @throws BadMethodCallException
      */
     public function getEventDispatcher()
     {
-        return null;
+        throw new BadMethodCallException('Buttons do not support event dispatching.');
     }
 
     /**
@@ -626,26 +628,32 @@ public function getFormFactory()
 
     /**
      * Unsupported method.
+     *
+     * @throws BadMethodCallException
      */
     public function getAction()
     {
-        return null;
+        throw new BadMethodCallException('Buttons do not support actions.');
     }
 
     /**
      * Unsupported method.
+     *
+     * @throws BadMethodCallException
      */
     public function getMethod()
     {
-        return null;
+        throw new BadMethodCallException('Buttons do not support methods.');
     }
 
     /**
      * Unsupported method.
+     *
+     * @throws BadMethodCallException
      */
     public function getRequestHandler()
     {
-        return null;
+        throw new BadMethodCallException('Buttons do not support request handlers.');
     }
 
     /**
diff --git a/src/Symfony/Component/Form/FormConfigBuilder.php b/src/Symfony/Component/Form/FormConfigBuilder.php
@@ -88,11 +88,7 @@ class FormConfigBuilder implements FormConfigBuilderInterface
      */
     private $formFactory;
 
-    /**
-     * @var string|null
-     */
-    private $action;
-
+    private $action = '';
     private $method = 'POST';
 
     /**
@@ -396,6 +392,10 @@ public function getDataLocked()
      */
     public function getFormFactory()
     {
+        if (!isset($this->formFactory)) {
+            throw new BadMethodCallException('The form factory must be set before retrieving it.');
+        }
+
         return $this->formFactory;
     }
 

Original file line number	Diff line number	Diff line change
`@@ -430,10 +430,12 @@ public function setIsEmptyCallback(?callable $isEmptyCallback)`
`430`	`430`
`431`	`431`	`/**`
`432`	`432`	`* Unsupported method.`
	`433`	`+ *`
	`434`	`+ * @throws BadMethodCallException`
`433`	`435`	`*/`
`434`	`436`	`public function getEventDispatcher()`
`435`	`437`	`{`
`436`		`- return null;`
	`438`	`+ throw new BadMethodCallException('Buttons do not support event dispatching.');`
`437`	`439`	`}`
`438`	`440`
`439`	`441`	`/**`
`@@ -626,26 +628,32 @@ public function getFormFactory()`
`626`	`628`
`627`	`629`	`/**`
`628`	`630`	`* Unsupported method.`
	`631`	`+ *`
	`632`	`+ * @throws BadMethodCallException`
`629`	`633`	`*/`
`630`	`634`	`public function getAction()`
`631`	`635`	`{`
`632`		`- return null;`
	`636`	`+ throw new BadMethodCallException('Buttons do not support actions.');`
`633`	`637`	`}`
`634`	`638`
`635`	`639`	`/**`
`636`	`640`	`* Unsupported method.`
	`641`	`+ *`
	`642`	`+ * @throws BadMethodCallException`
`637`	`643`	`*/`
`638`	`644`	`public function getMethod()`
`639`	`645`	`{`
`640`		`- return null;`
	`646`	`+ throw new BadMethodCallException('Buttons do not support methods.');`
`641`	`647`	`}`
`642`	`648`
`643`	`649`	`/**`
`644`	`650`	`* Unsupported method.`
	`651`	`+ *`
	`652`	`+ * @throws BadMethodCallException`
`645`	`653`	`*/`
`646`	`654`	`public function getRequestHandler()`
`647`	`655`	`{`
`648`		`- return null;`
	`656`	`+ throw new BadMethodCallException('Buttons do not support request handlers.');`
`649`	`657`	`}`
`650`	`658`
`651`	`659`	`/**`