[Workflow] Fixed BC break with MarkingStoreInterface::setMarking()

symfony · lyrixx · Mar 13, 2019 · Mar 12, 2019 · Mar 13, 2019 · 7a94e5eababe14b9adf706b4654e37c5a327f8c6
commit 7a94e5eababe14b9adf706b4654e37c5a327f8c6
diff --git a/UPGRADE-4.3.md b/UPGRADE-4.3.md
@@ -116,3 +116,28 @@ Yaml
 ----
 
  * Using a mapping inside a multi-line string is deprecated and will throw a `ParseException` in 5.0.
+
+Workflow
+--------
+
+ * `MarkingStoreInterface::setMarking()` will have a third argument in Symfony 5.0.
+
+   Before:
+   ```php
+   class MyMarkingStore implements MarkingStoreInterface
+   {
+       public function setMarking($subject, Marking $marking)
+       {
+       }
+   }
+   ```
+
+   After:
+   ```php
+   class MyMarkingStore implements MarkingStoreInterface
+   {
+       public function setMarking($subject, Marking $marking , array $context = [])
+       {
+       }
+   }
+   ```
diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
@@ -84,7 +84,7 @@ Finder
 
 Form
 ----
- 
+
  * Removed support for using the `format` option of `DateType` and `DateTimeType` when the `html5` option is enabled.
  * Using names for buttons that do not start with a letter, a digit, or an underscore leads to an exception.
  * Using names for buttons that do not contain only letters, digits, underscores, hyphens, and colons leads to an
@@ -352,6 +352,7 @@ Workflow
  * `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.
+ * `MarkingStoreInterface::setMarking()` has a third argument: `array $context = []`.
 
 Yaml
 ----

diff --git a/src/Symfony/Component/Workflow/MarkingStore/MarkingStoreInterface.php b/src/Symfony/Component/Workflow/MarkingStore/MarkingStoreInterface.php
@@ -37,6 +37,7 @@ public function getMarking($subject);
      * Sets a Marking to a subject.
      *
      * @param object $subject A subject
+     * @param array  $context Some context
      */
-    public function setMarking($subject, Marking $marking, array $context = []);
+    public function setMarking($subject, Marking $marking /*, array $context = []*/);
 }
diff --git a/src/Symfony/Component/Workflow/MarkingStore/MultipleStateMarkingStore.php b/src/Symfony/Component/Workflow/MarkingStore/MultipleStateMarkingStore.php
@@ -45,8 +45,10 @@ public function getMarking($subject)
 
     /**
      * {@inheritdoc}
+     *
+     * @param array $context Some context
      */
-    public function setMarking($subject, Marking $marking, array $context = [])
+    public function setMarking($subject, Marking $marking/*, array $context = []*/)
     {
         $this->propertyAccessor->setValue($subject, $this->property, $marking->getPlaces());
     }

diff --git a/src/Symfony/Component/Workflow/MarkingStore/SingleStateMarkingStore.php b/src/Symfony/Component/Workflow/MarkingStore/SingleStateMarkingStore.php
@@ -50,8 +50,10 @@ public function getMarking($subject)
 
     /**
      * {@inheritdoc}
+     *
+     * @param array $context Some context
      */
-    public function setMarking($subject, Marking $marking, array $context = [])
+    public function setMarking($subject, Marking $marking/*, array $context = []*/)
     {
         $this->propertyAccessor->setValue($subject, $this->property, key($marking->getPlaces()));
     }