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

lyrixx · lyrixx · commit 7a94e5eababe · 2019-03-13T10:27:38.000+01:00
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()));
     }

Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,7 @@ public function getMarking($subject);`
`37`	`37`	`* Sets a Marking to a subject.`
`38`	`38`	`*`
`39`	`39`	`* @param object $subject A subject`
	`40`	`+ * @param array $context Some context`
`40`	`41`	`*/`
`41`		`- public function setMarking($subject, Marking $marking, array $context = []);`
	`42`	`+ public function setMarking($subject, Marking $marking /, array $context = []/);`
`42`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,8 +45,10 @@ public function getMarking($subject)`
`45`	`45`
`46`	`46`	`/**`
`47`	`47`	`* {@inheritdoc}`
	`48`	`+ *`
	`49`	`+ * @param array $context Some context`
`48`	`50`	`*/`
`49`		`- public function setMarking($subject, Marking $marking, array $context = [])`
	`51`	`+ public function setMarking($subject, Marking $marking/, array $context = []/)`
`50`	`52`	`{`
`51`	`53`	`$this->propertyAccessor->setValue($subject, $this->property, $marking->getPlaces());`
`52`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -50,8 +50,10 @@ public function getMarking($subject)`
`50`	`50`
`51`	`51`	`/**`
`52`	`52`	`* {@inheritdoc}`
	`53`	`+ *`
	`54`	`+ * @param array $context Some context`
`53`	`55`	`*/`
`54`		`- public function setMarking($subject, Marking $marking, array $context = [])`
	`56`	`+ public function setMarking($subject, Marking $marking/, array $context = []/)`
`55`	`57`	`{`
`56`	`58`	`$this->propertyAccessor->setValue($subject, $this->property, key($marking->getPlaces()));`
`57`	`59`	`}`