[Config] Fix PHP Configuration type hints & tests

symfony · nicolas-grekas · May 17, 2022 · May 17, 2022 · May 17, 2022 · 9d38089d6ddadca4da178b59df8ab134f135e060
commit 9d38089d6ddadca4da178b59df8ab134f135e060
diff --git a/src/Symfony/Component/Config/Builder/ConfigBuilderGenerator.php b/src/Symfony/Component/Config/Builder/ConfigBuilderGenerator.php
@@ -145,7 +145,7 @@ private function handleArrayNode(ArrayNode $node, ClassBuilder $class, string $n
 /**
  * @return CLASS|$this
  */
-public function NAME($value = [])
+public function NAME(mixed $value = []): CLASS|static
 {
     if (!\is_array($value)) {
         $this->_usedProperties[\'PROPERTY\'] = true;
@@ -198,14 +198,19 @@ public function NAME(mixed $valueDEFAULT): static
 
     return $this;
 }';
-        $class->addMethod($node->getName(), $body, ['PROPERTY' => $property->getName(), 'COMMENT' => $comment, 'DEFAULT' => $node->hasDefaultValue() ? ' = '.var_export($node->getDefaultValue(), true) : '']);
+        $class->addMethod($node->getName(), $body, [
+            'PROPERTY' => $property->getName(),
+            'COMMENT' => $comment,
+            'DEFAULT' => $node->hasDefaultValue() ? ' = '.var_export($node->getDefaultValue(), true) : '',
+        ]);
     }
 
     private function handlePrototypedArrayNode(PrototypedArrayNode $node, ClassBuilder $class, string $namespace): void
     {
         $name = $this->getSingularName($node);
         $prototype = $node->getPrototype();
         $methodName = $name;
+        $hasNormalizationClosures = $this->hasNormalizationClosures($node) || $this->hasNormalizationClosures($prototype);
 
         $parameterType = $this->getParameterType($prototype);
         if (null !== $parameterType || $prototype instanceof ScalarNode) {
@@ -215,19 +220,23 @@ private function handlePrototypedArrayNode(PrototypedArrayNode $node, ClassBuild
                 // This is an array of values; don't use singular name
                 $body = '
 /**
- * @param ParamConfigurator|list<ParamConfigurator|TYPE> $value
+ * @param PHPDOC_TYPE $value
  *
  * @return $this
  */
-public function NAME(ParamConfigurator|array $value): static
+public function NAME(TYPE $value): static
 {
     $this->_usedProperties[\'PROPERTY\'] = true;
     $this->PROPERTY = $value;
 
     return $this;
 }';
 
-                $class->addMethod($node->getName(), $body, ['PROPERTY' => $property->getName(), 'TYPE' => '' === $parameterType ? 'mixed' : $parameterType]);
+                $class->addMethod($node->getName(), $body, [
+                    'PROPERTY' => $property->getName(),
+                    'TYPE' => $hasNormalizationClosures ? 'mixed' : 'ParamConfigurator|array',
+                    'PHPDOC_TYPE' => $hasNormalizationClosures ? 'mixed' : sprintf('ParamConfigurator|list<ParamConfigurator|%s>', '' === $parameterType ? 'mixed' : $parameterType),
+                ]);
             } else {
                 $body = '
 /**
@@ -241,7 +250,12 @@ public function NAME(string $VAR, TYPE $VALUE): static
     return $this;
 }';
 
-                $class->addMethod($methodName, $body, ['PROPERTY' => $property->getName(), 'TYPE' => '' === $parameterType ? 'mixed' : 'ParamConfigurator|'.$parameterType, 'VAR' => '' === $key ? 'key' : $key, 'VALUE' => 'value' === $key ? 'data' : 'value']);
+                $class->addMethod($methodName, $body, [
+                    'PROPERTY' => $property->getName(),
+                    'TYPE' => $hasNormalizationClosures || '' === $parameterType ? 'mixed' : 'ParamConfigurator|'.$parameterType,
+                    'VAR' => '' === $key ? 'key' : $key,
+                    'VALUE' => 'value' === $key ? 'data' : 'value',
+                ]);
             }
 
             return;
@@ -254,7 +268,6 @@ public function NAME(string $VAR, TYPE $VALUE): static
         $class->addRequire($childClass);
         $this->classes[] = $childClass;
 
-        $hasNormalizationClosures = $this->hasNormalizationClosures($node) || $this->hasNormalizationClosures($prototype);
         $property = $class->addProperty(
             $node->getName(),
             $this->getType($childClass->getFqcn().'[]', $hasNormalizationClosures)
@@ -265,7 +278,7 @@ public function NAME(string $VAR, TYPE $VALUE): static
 /**
  * @return CLASS|$this
  */
-public function NAME($value = [])
+public function NAME(mixed $value = []): CLASS|static
 {
     $this->_usedProperties[\'PROPERTY\'] = true;
     if (!\is_array($value)) {
@@ -288,7 +301,7 @@ public function NAME(array $value = []): CLASS
 /**
  * @return CLASS|$this
  */
-public function NAME(string $VAR, $VALUE = [])
+public function NAME(string $VAR, mixed $VALUE = []): CLASS|static
 {
     if (!\is_array($VALUE)) {
         $this->_usedProperties[\'PROPERTY\'] = true;
@@ -318,7 +331,12 @@ public function NAME(string $VAR, array $VALUE = []): CLASS
     return $this->PROPERTY[$VAR];
 }';
             $class->addUse(InvalidConfigurationException::class);
-            $class->addMethod($methodName, $body, ['PROPERTY' => $property->getName(), 'CLASS' => $childClass->getFqcn(), 'VAR' => '' === $key ? 'key' : $key, 'VALUE' => 'value' === $key ? 'data' : 'value']);
+            $class->addMethod($methodName, $body, [
+                'PROPERTY' => $property->getName(),
+                'CLASS' => $childClass->getFqcn(),
+                'VAR' => '' === $key ? 'key' : $key,
+                'VALUE' => 'value' === $key ? 'data' : 'value',
+            ]);
         }
 
         $this->buildNode($prototype, $childClass, $namespace.'\\'.$childClass->getName());

diff --git a/...ures/ScalarNormalizedTypes/Symfony/Config/ScalarNormalizedTypes/KeyedListObjectConfig.php b/...ures/ScalarNormalizedTypes/Symfony/Config/ScalarNormalizedTypes/KeyedListObjectConfig.php
@@ -19,7 +19,7 @@ class KeyedListObjectConfig
      * @param ParamConfigurator|bool $value
      * @return $this
      */
-    public function enabled($value): self
+    public function enabled($value): static
     {
         $this->_usedProperties['enabled'] = true;
         $this->enabled = $value;
@@ -28,10 +28,11 @@ public function enabled($value): self
     }
 
     /**
-     * @param ParamConfigurator|list<mixed|ParamConfigurator> $value
+     * @param ParamConfigurator|list<ParamConfigurator|mixed> $value
+     *
      * @return $this
      */
-    public function settings($value): self
+    public function settings(ParamConfigurator|array $value): static
     {
         $this->_usedProperties['settings'] = true;
         $this->settings = $value;

diff --git a/.../Fixtures/ScalarNormalizedTypes/Symfony/Config/ScalarNormalizedTypes/ListObjectConfig.php b/.../Fixtures/ScalarNormalizedTypes/Symfony/Config/ScalarNormalizedTypes/ListObjectConfig.php
@@ -19,7 +19,7 @@ class ListObjectConfig
      * @param ParamConfigurator|mixed $value
      * @return $this
      */
-    public function name($value): self
+    public function name($value): static
     {
         $this->_usedProperties['name'] = true;
         $this->name = $value;
@@ -28,10 +28,11 @@ public function name($value): self
     }
 
     /**
-     * @param ParamConfigurator|list<mixed|ParamConfigurator> $value
+     * @param ParamConfigurator|list<ParamConfigurator|mixed> $value
+     *
      * @return $this
      */
-    public function data($value): self
+    public function data(ParamConfigurator|array $value): static
     {
         $this->_usedProperties['data'] = true;
         $this->data = $value;

diff --git a/...larNormalizedTypes/Symfony/Config/ScalarNormalizedTypes/Nested/NestedListObjectConfig.php b/...larNormalizedTypes/Symfony/Config/ScalarNormalizedTypes/Nested/NestedListObjectConfig.php
@@ -18,7 +18,7 @@ class NestedListObjectConfig
      * @param ParamConfigurator|mixed $value
      * @return $this
      */
-    public function name($value): self
+    public function name($value): static
     {
         $this->_usedProperties['name'] = true;
         $this->name = $value;

diff --git a/.../ScalarNormalizedTypes/Symfony/Config/ScalarNormalizedTypes/Nested/NestedObjectConfig.php b/.../ScalarNormalizedTypes/Symfony/Config/ScalarNormalizedTypes/Nested/NestedObjectConfig.php
@@ -18,7 +18,7 @@ class NestedObjectConfig
      * @param ParamConfigurator|bool $value
      * @return $this
      */
-    public function enabled($value): self
+    public function enabled($value): static
     {
         $this->_usedProperties['enabled'] = true;
         $this->enabled = $value;

diff --git a/...lder/Fixtures/ScalarNormalizedTypes/Symfony/Config/ScalarNormalizedTypes/NestedConfig.php b/...lder/Fixtures/ScalarNormalizedTypes/Symfony/Config/ScalarNormalizedTypes/NestedConfig.php
@@ -19,7 +19,7 @@ class NestedConfig
     /**
      * @return \Symfony\Config\ScalarNormalizedTypes\Nested\NestedObjectConfig|$this
      */
-    public function nestedObject($value = [])
+    public function nestedObject(mixed $value = []): \Symfony\Config\ScalarNormalizedTypes\Nested\NestedObjectConfig|static
     {
         if (!\is_array($value)) {
             $this->_usedProperties['nestedObject'] = true;
@@ -41,7 +41,7 @@ public function nestedObject($value = [])
     /**
      * @return \Symfony\Config\ScalarNormalizedTypes\Nested\NestedListObjectConfig|$this
      */
-    public function nestedListObject($value = [])
+    public function nestedListObject(mixed $value = []): \Symfony\Config\ScalarNormalizedTypes\Nested\NestedListObjectConfig|static
     {
         $this->_usedProperties['nestedListObject'] = true;
         if (!\is_array($value)) {

diff --git a/...lder/Fixtures/ScalarNormalizedTypes/Symfony/Config/ScalarNormalizedTypes/ObjectConfig.php b/...lder/Fixtures/ScalarNormalizedTypes/Symfony/Config/ScalarNormalizedTypes/ObjectConfig.php
@@ -20,7 +20,7 @@ class ObjectConfig
      * @param ParamConfigurator|bool $value
      * @return $this
      */
-    public function enabled($value): self
+    public function enabled($value): static
     {
         $this->_usedProperties['enabled'] = true;
         $this->enabled = $value;
@@ -33,7 +33,7 @@ public function enabled($value): self
      * @param ParamConfigurator|mixed $value
      * @return $this
      */
-    public function dateFormat($value): self
+    public function dateFormat($value): static
     {
         $this->_usedProperties['dateFormat'] = true;
         $this->dateFormat = $value;
@@ -46,7 +46,7 @@ public function dateFormat($value): self
      * @param ParamConfigurator|bool $value
      * @return $this
      */
-    public function removeUsedContextFields($value): self
+    public function removeUsedContextFields($value): static
     {
         $this->_usedProperties['removeUsedContextFields'] = true;
         $this->removeUsedContextFields = $value;

diff --git a/...sts/Builder/Fixtures/ScalarNormalizedTypes/Symfony/Config/ScalarNormalizedTypesConfig.php b/...sts/Builder/Fixtures/ScalarNormalizedTypes/Symfony/Config/ScalarNormalizedTypesConfig.php
@@ -24,10 +24,11 @@ class ScalarNormalizedTypesConfig implements \Symfony\Component\Config\Builder\C
     private $_usedProperties = [];
 
     /**
-     * @param ParamConfigurator|list<mixed|ParamConfigurator> $value
+     * @param mixed $value
+     *
      * @return $this
      */
-    public function simpleArray($value): self
+    public function simpleArray(mixed $value): static
     {
         $this->_usedProperties['simpleArray'] = true;
         $this->simpleArray = $value;
@@ -36,10 +37,9 @@ public function simpleArray($value): self
     }
 
     /**
-     * @param ParamConfigurator|array $value
      * @return $this
      */
-    public function keyedArray(string $name, $value): self
+    public function keyedArray(string $name, mixed $value): static
     {
         $this->_usedProperties['keyedArray'] = true;
         $this->keyedArray[$name] = $value;
@@ -50,7 +50,7 @@ public function keyedArray(string $name, $value): self
     /**
      * @return \Symfony\Config\ScalarNormalizedTypes\ObjectConfig|$this
      */
-    public function object($value = [])
+    public function object(mixed $value = []): \Symfony\Config\ScalarNormalizedTypes\ObjectConfig|static
     {
         if (!\is_array($value)) {
             $this->_usedProperties['object'] = true;
@@ -72,7 +72,7 @@ public function object($value = [])
     /**
      * @return \Symfony\Config\ScalarNormalizedTypes\ListObjectConfig|$this
      */
-    public function listObject($value = [])
+    public function listObject(mixed $value = []): \Symfony\Config\ScalarNormalizedTypes\ListObjectConfig|static
     {
         $this->_usedProperties['listObject'] = true;
         if (!\is_array($value)) {
@@ -87,7 +87,7 @@ public function listObject($value = [])
     /**
      * @return \Symfony\Config\ScalarNormalizedTypes\KeyedListObjectConfig|$this
      */
-    public function keyedListObject(string $class, $value = [])
+    public function keyedListObject(string $class, mixed $value = []): \Symfony\Config\ScalarNormalizedTypes\KeyedListObjectConfig|static
     {
         if (!\is_array($value)) {
             $this->_usedProperties['keyedListObject'] = true;