bug #49682 [FrameworkBundle] Workflow - Fix LogicException about a wrong configuration of "enabled" node (adpauly)

fabpot · fabpot · commit b1817723868c · 2023-03-25T10:03:25.000+01:00
This PR was merged into the 5.4 branch. Discussion ---------- [FrameworkBundle] Workflow - Fix LogicException about a wrong configuration of "enabled" node | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | / | License | MIT | Doc PR | / When I try to configure the YAML node "enabled" under a workflow configuration: ```yaml framework: workflows: order_approval_state: enabled: false # <--- HERE type: state_machine supports: - AppBundle\Entity\OrderApproval ``` The following exception is thrown: ```php //vendor/symfony/symfony/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php if (isset($workflow['enabled']) && false === $workflow['enabled']) { throw new LogicException(sprintf('Cannot disable a single workflow. Remove the configuration for the workflow "%s" instead.', $workflow['name'])); } ``` But it actually throws the following PHP error: ```bash In Configuration.php line 262: Notice: Undefined index: name ``` I think we should use the **`$key` variable instead of this undefined index.** `$key` contains the workflow name. When changing, I get the attempted exception: ```bash In Configuration.php line 262: Cannot disable a single workflow. Remove the configuration for the workflow "order_approval_state" instead. ``` (I took a look in 6.2, it doesn't fix yet.) Commits ------- 14a4fcf [FrameworkBundle] Workflow - Fix LogicException about a wrong configuration of "enabled" node
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -350,7 +350,7 @@ private function addWorkflowSection(ArrayNodeDefinition $rootNode)
 
                                 foreach ($workflows as $key => $workflow) {
                                     if (isset($workflow['enabled']) && false === $workflow['enabled']) {
-                                        throw new LogicException(sprintf('Cannot disable a single workflow. Remove the configuration for the workflow "%s" instead.', $workflow['name']));
+                                        throw new LogicException(sprintf('Cannot disable a single workflow. Remove the configuration for the workflow "%s" instead.', $key));
                                     }
 
                                     unset($workflows[$key]['enabled']);

Original file line number	Diff line number	Diff line change
`@@ -350,7 +350,7 @@ private function addWorkflowSection(ArrayNodeDefinition $rootNode)`
`350`	`350`
`351`	`351`	`foreach ($workflows as $key => $workflow) {`
`352`	`352`	`if (isset($workflow['enabled']) && false === $workflow['enabled']) {`
`353`		`- throw new LogicException(sprintf('Cannot disable a single workflow. Remove the configuration for the workflow "%s" instead.', $workflow['name']));`
	`353`	`+ throw new LogicException(sprintf('Cannot disable a single workflow. Remove the configuration for the workflow "%s" instead.', $key));`
`354`	`354`	`}`
`355`	`355`
`356`	`356`	`unset($workflows[$key]['enabled']);`