[Config] Add conditional types to conditional builders

wouterj · wouterj · commit fbf15a81e571 · 2022-06-09T23:17:27.000+02:00
This allows static analysis tools to understand what type is returned.
diff --git a/src/Symfony/Component/Config/Builder/ConfigBuilderGenerator.php b/src/Symfony/Component/Config/Builder/ConfigBuilderGenerator.php
@@ -143,6 +143,10 @@ private function handleArrayNode(ArrayNode $node, ClassBuilder $class, string $n
         );
         $body = $hasNormalizationClosures ? '
 /**
+ * @template T
+ * @psalm-param T $value
+ * @psalm-return (T is array ? CLASS : static)
+ *
  * @return CLASS|$this
  */
 public function NAME($value = [])
@@ -262,6 +266,10 @@ public function NAME(string $VAR, $VALUE): self
         if (null === $key = $node->getKeyAttribute()) {
             $body = $hasNormalizationClosures ? '
 /**
+ * @template T
+ * @psalm-param T $value
+ * @psalm-return (T is array ? CLASS : static)
+ *
  * @return CLASS|$this
  */
 public function NAME($value = [])
@@ -285,7 +293,11 @@ public function NAME(array $value = []): CLASS
         } else {
             $body = $hasNormalizationClosures ? '
 /**
+ * @template T
+ * @psalm-param T $value
+ *
  * @return CLASS|$this
+ * @psalm-return (T is array ? CLASS : static)
  */
 public function NAME(string $VAR, $VALUE = [])
 {
diff --git a/src/Symfony/Component/Config/Tests/Builder/Fixtures/ScalarNormalizedTypes/Symfony/Config/ScalarNormalizedTypes/NestedConfig.php b/src/Symfony/Component/Config/Tests/Builder/Fixtures/ScalarNormalizedTypes/Symfony/Config/ScalarNormalizedTypes/NestedConfig.php
@@ -17,6 +17,10 @@ class NestedConfig
     private $_usedProperties = [];
 
     /**
+     * @template T
+     * @psalm-param T $value
+     * @psalm-return (T is array ? \Symfony\Config\ScalarNormalizedTypes\Nested\NestedObjectConfig : static)
+     *
      * @return \Symfony\Config\ScalarNormalizedTypes\Nested\NestedObjectConfig|$this
      */
     public function nestedObject($value = [])
@@ -39,6 +43,10 @@ public function nestedObject($value = [])
     }
 
     /**
+     * @template T
+     * @psalm-param T $value
+     * @psalm-return (T is array ? \Symfony\Config\ScalarNormalizedTypes\Nested\NestedListObjectConfig : static)
+     *
      * @return \Symfony\Config\ScalarNormalizedTypes\Nested\NestedListObjectConfig|$this
      */
     public function nestedListObject($value = [])
diff --git a/src/Symfony/Component/Config/Tests/Builder/Fixtures/ScalarNormalizedTypes/Symfony/Config/ScalarNormalizedTypesConfig.php b/src/Symfony/Component/Config/Tests/Builder/Fixtures/ScalarNormalizedTypes/Symfony/Config/ScalarNormalizedTypesConfig.php
@@ -48,6 +48,10 @@ public function keyedArray(string $name, $value): self
     }
 
     /**
+     * @template T
+     * @psalm-param T $value
+     * @psalm-return (T is array ? \Symfony\Config\ScalarNormalizedTypes\ObjectConfig : static)
+     *
      * @return \Symfony\Config\ScalarNormalizedTypes\ObjectConfig|$this
      */
     public function object($value = [])
@@ -70,6 +74,10 @@ public function object($value = [])
     }
 
     /**
+     * @template T
+     * @psalm-param T $value
+     * @psalm-return (T is array ? \Symfony\Config\ScalarNormalizedTypes\ListObjectConfig : static)
+     *
      * @return \Symfony\Config\ScalarNormalizedTypes\ListObjectConfig|$this
      */
     public function listObject($value = [])
@@ -85,6 +93,10 @@ public function listObject($value = [])
     }
 
     /**
+     * @template T
+     * @psalm-param T $value
+     * @psalm-return (T is array ? \Symfony\Config\ScalarNormalizedTypes\KeyedListObjectConfig : static)
+     *
      * @return \Symfony\Config\ScalarNormalizedTypes\KeyedListObjectConfig|$this
      */
     public function keyedListObject(string $class, $value = [])
