[Workflow] Deprecate MultipleStateMarkingStore and SingleStateMarkingStore in favor of MethodMarkingStore

lyrixx · lyrixx · commit 7b982c83d628 · 2019-03-13T17:02:15.000+01:00
diff --git a/UPGRADE-4.3.md b/UPGRADE-4.3.md
@@ -110,3 +110,49 @@ Yaml
 ----
 
  * Using a mapping inside a multi-line string is deprecated and will throw a `ParseException` in 5.0.
+
+Workflow
+--------
+
+ * `MultipleStateMarkingStore` is deprecated. Use `MethodMarkingStore` instead.
+
+   Before:
+   ```yaml
+   framework:
+       workflows:
+           article:
+               marking_store:
+                   type: multiple
+   ```
+
+   After:
+   ```yaml
+   framework:
+       workflows:
+           article:
+               marking_store:
+                   type: method
+
+   ```
+
+ * `SingleStateMarkingStore` is deprecated. Use `MethodMarkingStore` instead.
+
+   Before:
+   ```yaml
+   framework:
+       workflows:
+           article:
+               marking_store:
+                   type: single
+   ```
+
+   After:
+   ```yaml
+   framework:
+       workflows:
+           article:
+               marking_store:
+                   type: method
+                   arguments:
+                       - true
+   ```
diff --git a/src/Symfony/Component/Workflow/CHANGELOG.md b/src/Symfony/Component/Workflow/CHANGELOG.md
@@ -4,8 +4,10 @@ CHANGELOG
 4.3.0
 -----
 
- * Trigger `entered` event for subject entering in the Workflow for the first time
+ * Trigger `entered` event for subject entering in the Workflow for the first time.
  * Added a context to `Workflow::apply()`. The `MethodMarkingStore` could be used to leverage this feature.
+ * Deprecated the `MultipleStateMarkingStore` class, use the `MethodMarkingStore` instead.
+ * Deprecated the `SingleStateMarkingStore` class, use the `MethodMarkingStore` instead.
 
 4.1.0
 -----
diff --git a/src/Symfony/Component/Workflow/MarkingStore/MethodMarkingStore.php b/src/Symfony/Component/Workflow/MarkingStore/MethodMarkingStore.php
@@ -19,6 +19,12 @@
  *
  * This store deals with a "single state" or "multiple state" Marking.
  *
+ * "single state" Marking means a subject can be in one and only one state at
+ * the same time. Use it with state machine or specific workflow.
+ *
+ * "multiple state" Marking means a subject can be in many states at the same
+ * time. Use it with workflow.
+ *
  * @author Grégoire Pineau <lyrixx@lyrixx.info>
  */
 class MethodMarkingStore implements MarkingStoreInterface
diff --git a/src/Symfony/Component/Workflow/MarkingStore/MultipleStateMarkingStore.php b/src/Symfony/Component/Workflow/MarkingStore/MultipleStateMarkingStore.php
@@ -22,6 +22,8 @@
  * This store deals with a "multiple state" Marking. It means a subject can be
  * in many states at the same time.
  *
+ * @deprecated since Symfony 4.3. Use MethodMarkingStore instead.
+ *
  * @author Grégoire Pineau <lyrixx@lyrixx.info>
  */
 class MultipleStateMarkingStore implements MarkingStoreInterface
diff --git a/src/Symfony/Component/Workflow/MarkingStore/SingleStateMarkingStore.php b/src/Symfony/Component/Workflow/MarkingStore/SingleStateMarkingStore.php
@@ -21,6 +21,8 @@
  * This store deals with a "single state" Marking. It means a subject can be in
  * one and only one state at the same time.
  *
+ * @deprecated since Symfony 4.3. Use MethodMarkingStore instead.
+ *
  * @author Grégoire Pineau <lyrixx@lyrixx.info>
  */
 class SingleStateMarkingStore implements MarkingStoreInterface

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,12 @@`
`19`	`19`	`*`
`20`	`20`	`* This store deals with a "single state" or "multiple state" Marking.`
`21`	`21`	`*`
	`22`	`+ * "single state" Marking means a subject can be in one and only one state at`
	`23`	`+ * the same time. Use it with state machine or specific workflow.`
	`24`	`+ *`
	`25`	`+ * "multiple state" Marking means a subject can be in many states at the same`
	`26`	`+ * time. Use it with workflow.`
	`27`	`+ *`
`22`	`28`	`* @author Grégoire Pineau <[email protected]>`
`23`	`29`	`*/`
`24`	`30`	`class MethodMarkingStore implements MarkingStoreInterface`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,8 @@`
`22`	`22`	`* This store deals with a "multiple state" Marking. It means a subject can be`
`23`	`23`	`* in many states at the same time.`
`24`	`24`	`*`
	`25`	`+ * @deprecated since Symfony 4.3. Use MethodMarkingStore instead.`
	`26`	`+ *`
`25`	`27`	`* @author Grégoire Pineau <[email protected]>`
`26`	`28`	`*/`
`27`	`29`	`class MultipleStateMarkingStore implements MarkingStoreInterface`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,8 @@`
`21`	`21`	`* This store deals with a "single state" Marking. It means a subject can be in`
`22`	`22`	`* one and only one state at the same time.`
`23`	`23`	`*`
	`24`	`+ * @deprecated since Symfony 4.3. Use MethodMarkingStore instead.`
	`25`	`+ *`
`24`	`26`	`* @author Grégoire Pineau <[email protected]>`
`25`	`27`	`*/`
`26`	`28`	`class SingleStateMarkingStore implements MarkingStoreInterface`