feature #59630 [FrameworkBundle] Add support for info on ArrayNodeDefinition::canBeEnabled() and ArrayNodeDefinition::canBeDisabled() (alexandre-daubois)

nicolas-grekas · nicolas-grekas · commit 0deaa1e75f5c · 2025-01-28T17:07:34.000+01:00
This PR was merged into the 7.3 branch. Discussion ---------- [FrameworkBundle] Add support for info on `ArrayNodeDefinition::canBeEnabled()` and `ArrayNodeDefinition::canBeDisabled()` | Q | A | ------------- | --- | Branch? | 7.3 | Bug fix? | no | New feature? | yes | Deprecations? | no | Issues | - | License | MIT After #59628 (comment) (cc `@GromNaN`), supersedes #59628 is merged. Commits ------- 857b778 [FrameworkBundle] Add support for info on `ArrayNodeDefinition::canBeEnabled()` and `ArrayNodeDefinition::canBeDisabled()`
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -1054,12 +1054,8 @@ private function addValidationSection(ArrayNodeDefinition $rootNode, callable $e
                             ->end()
                         ->end()
                         ->arrayNode('not_compromised_password')
-                            ->canBeDisabled()
+                            ->canBeDisabled('When disabled, compromised passwords will be accepted as valid.')
                             ->children()
-                                ->booleanNode('enabled')
-                                    ->defaultTrue()
-                                    ->info('When disabled, compromised passwords will be accepted as valid.')
-                                ->end()
                                 ->scalarNode('endpoint')
                                     ->defaultNull()
                                     ->info('API endpoint for the NotCompromisedPassword Validator.')
diff --git a/src/Symfony/Component/Config/CHANGELOG.md b/src/Symfony/Component/Config/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Add `ExprBuilder::ifFalse()`
+ * Add support for info on `ArrayNodeDefinition::canBeEnabled()` and `ArrayNodeDefinition::canBeDisabled()`
 
 7.2
 ---
diff --git a/src/Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php b/src/Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php
@@ -239,11 +239,13 @@ public function canBeUnset(bool $allow = true): static
      * enableableArrayNode: {enabled: false, ...}  # The config is disabled
      * enableableArrayNode: false                  # The config is disabled
      *
+     * @param string|null $info A description of what happens when the node is enabled or disabled
+     *
      * @return $this
      */
-    public function canBeEnabled(): static
+    public function canBeEnabled(/* ?string $info = null */): static
     {
-        $this
+        $node = $this
             ->addDefaultsIfNotSet()
             ->treatFalseLike(['enabled' => false])
             ->treatTrueLike(['enabled' => true])
@@ -261,6 +263,11 @@ public function canBeEnabled(): static
                     ->defaultFalse()
         ;
 
+        $info = 1 <= \func_num_args() ? func_get_arg(0) : null;
+        if ($info) {
+            $node->info($info);
+        }
+
         return $this;
     }
 
@@ -269,11 +276,13 @@ public function canBeEnabled(): static
      *
      * By default, the section is enabled.
      *
+     * @param string|null $info A description of what happens when the node is enabled or disabled
+     *
      * @return $this
      */
-    public function canBeDisabled(): static
+    public function canBeDisabled(/* ?string $info = null */): static
     {
-        $this
+        $node = $this
             ->addDefaultsIfNotSet()
             ->treatFalseLike(['enabled' => false])
             ->treatTrueLike(['enabled' => true])
@@ -283,6 +292,11 @@ public function canBeDisabled(): static
                     ->defaultTrue()
         ;
 
+        $info = 1 <= \func_num_args() ? func_get_arg(0) : null;
+        if ($info) {
+            $node->info($info);
+        }
+
         return $this;
     }
 
diff --git a/src/Symfony/Component/Config/Tests/Definition/Builder/ArrayNodeDefinitionTest.php b/src/Symfony/Component/Config/Tests/Definition/Builder/ArrayNodeDefinitionTest.php
@@ -190,6 +190,16 @@ public function testTrueEnableEnabledNode(array $expected, array $config, string
         );
     }
 
+    public function testCanBeEnabledWithInfo()
+    {
+        $node = new ArrayNodeDefinition('root');
+        $node->canBeEnabled('Some info about disabling this node');
+
+        $child = $this->getField($node, 'children')['enabled'];
+
+        $this->assertEquals('Some info about disabling this node', $this->getField($child, 'attributes')['info']);
+    }
+
     public function testCanBeDisabled()
     {
         $node = new ArrayNodeDefinition('root');
@@ -208,6 +218,16 @@ public function testCanBeDisabled()
         $this->assertTrue($this->getField($enabledNode, 'defaultValue'));
     }
 
+    public function testCanBeDisabledWithInfo()
+    {
+        $node = new ArrayNodeDefinition('root');
+        $node->canBeDisabled('Some info about disabling this node');
+
+        $child = $this->getField($node, 'children')['enabled'];
+
+        $this->assertEquals('Some info about disabling this node', $this->getField($child, 'attributes')['info']);
+    }
+
     public function testIgnoreExtraKeys()
     {
         $node = new ArrayNodeDefinition('root');

Original file line number	Diff line number	Diff line change
`@@ -239,11 +239,13 @@ public function canBeUnset(bool $allow = true): static`
`239`	`239`	`* enableableArrayNode: {enabled: false, ...} # The config is disabled`
`240`	`240`	`* enableableArrayNode: false # The config is disabled`
`241`	`241`	`*`
	`242`	`+ * @param string\|null $info A description of what happens when the node is enabled or disabled`
	`243`	`+ *`
`242`	`244`	`* @return $this`
`243`	`245`	`*/`
`244`		`- public function canBeEnabled(): static`
	`246`	`+ public function canBeEnabled(/* ?string $info = null */): static`
`245`	`247`	`{`
`246`		`- $this`
	`248`	`+ $node = $this`
`247`	`249`	`->addDefaultsIfNotSet()`
`248`	`250`	`->treatFalseLike(['enabled' => false])`
`249`	`251`	`->treatTrueLike(['enabled' => true])`
`@@ -261,6 +263,11 @@ public function canBeEnabled(): static`
`261`	`263`	`->defaultFalse()`
`262`	`264`	`;`
`263`	`265`
	`266`	`+ $info = 1 <= \func_num_args() ? func_get_arg(0) : null;`
	`267`	`+ if ($info) {`
	`268`	`+ $node->info($info);`
	`269`	`+ }`
	`270`	`+`
`264`	`271`	`return $this;`
`265`	`272`	`}`
`266`	`273`
`@@ -269,11 +276,13 @@ public function canBeEnabled(): static`
`269`	`276`	`*`
`270`	`277`	`* By default, the section is enabled.`
`271`	`278`	`*`
	`279`	`+ * @param string\|null $info A description of what happens when the node is enabled or disabled`
	`280`	`+ *`
`272`	`281`	`* @return $this`
`273`	`282`	`*/`
`274`		`- public function canBeDisabled(): static`
	`283`	`+ public function canBeDisabled(/* ?string $info = null */): static`
`275`	`284`	`{`
`276`		`- $this`
	`285`	`+ $node = $this`
`277`	`286`	`->addDefaultsIfNotSet()`
`278`	`287`	`->treatFalseLike(['enabled' => false])`
`279`	`288`	`->treatTrueLike(['enabled' => true])`
`@@ -283,6 +292,11 @@ public function canBeDisabled(): static`
`283`	`292`	`->defaultTrue()`
`284`	`293`	`;`
`285`	`294`
	`295`	`+ $info = 1 <= \func_num_args() ? func_get_arg(0) : null;`
	`296`	`+ if ($info) {`
	`297`	`+ $node->info($info);`
	`298`	`+ }`
	`299`	`+`
`286`	`300`	`return $this;`
`287`	`301`	`}`
`288`	`302`