feature #27092 [Workflow] "clear()" instead of "reset()" (nicolas-grekas)

fabpot · fabpot · commit 5a5b925f5459 · 2018-04-30T08:37:10.000+02:00
This PR was merged into the 4.1-dev branch. Discussion ---------- [Workflow] "clear()" instead of "reset()" | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - While working on another PR (to come), I noticed that the workflow component is using the word "reset" for something that is consistently called "clear" in the rest of the code base (emptying the state of an object) - and also that "reset" is consistently used for setting an object back to its initial state (which might not be the empty state, contrary to what clear does). Here is a PR fixing this inconsistency. Should be on 4.1 so that we won't have to deal with another BC layer in 4.2. Commits ------- 858fabb [Workflow] "clear()" instead of "reset()"
diff --git a/UPGRADE-4.1.md b/UPGRADE-4.1.md
@@ -154,6 +154,7 @@ Validator
 Workflow
 --------
 
+ * Deprecated the `DefinitionBuilder::reset()` method, use the `clear()` one instead.
  * Deprecated the `add` method in favor of the `addWorkflow` method in `Workflow\Registry`.
  * Deprecated `SupportStrategyInterface` in favor of `WorkflowSupportStrategyInterface`.
  * Deprecated the class `ClassInstanceSupportStrategy` in favor of the class `InstanceOfSupportStrategy`.
diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
@@ -107,6 +107,7 @@ Validator
 Workflow
 --------
 
+ * The `DefinitionBuilder::reset()` method has been removed, use the `clear()` one instead.
  * `add` method has been removed use `addWorkflow` method in `Workflow\Registry` instead.
  * `SupportStrategyInterface` has been removed, use `WorkflowSupportStrategyInterface` instead.
  * `ClassInstanceSupportStrategy` has been removed, use `InstanceOfSupportStrategy` instead.
diff --git a/src/Symfony/Component/Workflow/CHANGELOG.md b/src/Symfony/Component/Workflow/CHANGELOG.md
@@ -4,8 +4,9 @@ CHANGELOG
 4.1.0
 -----
 
- * Deprecate the usage of `add(Workflow $workflow, $supportStrategy)` in `Workflow/Registry`, use `addWorkflow(WorkflowInterface, $supportStrategy)` instead.
- * Deprecate the usage of `SupportStrategyInterface`, use `WorkflowSupportStrategyInterface` instead.
+ * Deprecated the `DefinitionBuilder::reset()` method, use the `clear()` one instead.
+ * Deprecated the usage of `add(Workflow $workflow, $supportStrategy)` in `Workflow/Registry`, use `addWorkflow(WorkflowInterface, $supportStrategy)` instead.
+ * Deprecated the usage of `SupportStrategyInterface`, use `WorkflowSupportStrategyInterface` instead.
  * The `Workflow` class now implements `WorkflowInterface`.
  * Deprecated the class `ClassInstanceSupportStrategy` in favor of the class `InstanceOfSupportStrategy`.
  * Added TransitionBlockers as a way to pass around reasons why exactly
diff --git a/src/Symfony/Component/Workflow/DefinitionBuilder.php b/src/Symfony/Component/Workflow/DefinitionBuilder.php
@@ -47,7 +47,7 @@ public function build()
      *
      * @return $this
      */
-    public function reset()
+    public function clear()
     {
         $this->places = array();
         $this->transitions = array();
@@ -121,4 +121,16 @@ public function addTransition(Transition $transition)
 
         return $this;
     }
+
+    /**
+     * @deprecated since Symfony 4.1, use the clear() method instead.
+     *
+     * @return $this
+     */
+    public function reset()
+    {
+        @trigger_error(sprintf('The "%s" method is deprecated since Symfony 4.1, use the "clear()" method instead.', __METHOD__), E_USER_DEPRECATED);
+
+        return $this->clear();
+    }
 }
diff --git a/src/Symfony/Component/Workflow/Event/GuardEvent.php b/src/Symfony/Component/Workflow/Event/GuardEvent.php
@@ -42,7 +42,7 @@ public function isBlocked()
     public function setBlocked($blocked)
     {
         if (!$blocked) {
-            $this->transitionBlockerList->reset();
+            $this->transitionBlockerList->clear();
 
             return;
         }
diff --git a/src/Symfony/Component/Workflow/TransitionBlockerList.php b/src/Symfony/Component/Workflow/TransitionBlockerList.php
@@ -37,7 +37,7 @@ public function add(TransitionBlocker $blocker): void
         $this->blockers[] = $blocker;
     }
 
-    public function reset(): void
+    public function clear(): void
     {
         $this->blockers = array();
     }

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ public function build()`
`47`	`47`	`*`
`48`	`48`	`* @return $this`
`49`	`49`	`*/`
`50`		`- public function reset()`
	`50`	`+ public function clear()`
`51`	`51`	`{`
`52`	`52`	`$this->places = array();`
`53`	`53`	`$this->transitions = array();`
`@@ -121,4 +121,16 @@ public function addTransition(Transition $transition)`
`121`	`121`
`122`	`122`	`return $this;`
`123`	`123`	`}`
	`124`	`+`
	`125`	`+ /**`
	`126`	`+ * @deprecated since Symfony 4.1, use the clear() method instead.`
	`127`	`+ *`
	`128`	`+ * @return $this`
	`129`	`+ */`
	`130`	`+ public function reset()`
	`131`	`+ {`
	`132`	`+ @trigger_error(sprintf('The "%s" method is deprecated since Symfony 4.1, use the "clear()" method instead.', __METHOD__), E_USER_DEPRECATED);`
	`133`	`+`
	`134`	`+ return $this->clear();`
	`135`	`+ }`
`124`	`136`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ public function isBlocked()`
`42`	`42`	`public function setBlocked($blocked)`
`43`	`43`	`{`
`44`	`44`	`if (!$blocked) {`
`45`		`- $this->transitionBlockerList->reset();`
	`45`	`+ $this->transitionBlockerList->clear();`
`46`	`46`
`47`	`47`	`return;`
`48`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public function add(TransitionBlocker $blocker): void`
`37`	`37`	`$this->blockers[] = $blocker;`
`38`	`38`	`}`
`39`	`39`
`40`		`- public function reset(): void`
	`40`	`+ public function clear(): void`
`41`	`41`	`{`
`42`	`42`	`$this->blockers = array();`
`43`	`43`	`}`