[Workflow] symfony#24501 Transition blockers.

d-ph · d-ph · commit 492080bb9df8 · 2017-10-29T17:04:09.000Z
diff --git a/src/Symfony/Component/Workflow/Event/GuardEvent.php b/src/Symfony/Component/Workflow/Event/GuardEvent.php
@@ -22,7 +22,6 @@
  */
 class GuardEvent extends Event
 {
-    private $blocked = false;
     private $transitionBlockerList;
 
     /**
@@ -37,12 +36,17 @@ public function __construct($subject, Marking $marking, Transition $transition,
 
     public function isBlocked()
     {
-        return $this->blocked;
+        return 0 !== count($this->transitionBlockerList);
     }
 
     public function setBlocked($blocked)
     {
-        $this->blocked = (bool) $blocked;
+        if (!$blocked) {
+            $this->transitionBlockerList = new TransitionBlockerList();
+            return;
+        }
+
+        $this->transitionBlockerList->add(TransitionBlocker::createUnknownReason($this->getTransition()->getName()));
     }
 
     /**
@@ -58,7 +62,5 @@ public function getTransitionBlockerList()
     public function addTransitionBlocker(TransitionBlocker $transitionBlocker)
     {
         $this->transitionBlockerList->add($transitionBlocker);
-
-        $this->setBlocked(true);
     }
 }
diff --git a/src/Symfony/Component/Workflow/TransitionBlocker.php b/src/Symfony/Component/Workflow/TransitionBlocker.php
@@ -18,6 +18,7 @@ class TransitionBlocker
 {
     const REASON_CODE_TRANSITION_NOT_DEFINED = 'com.symfony.www.workflow.transition_blocker.not_defined';
     const REASON_CODE_TRANSITION_NOT_APPLICABLE = 'com.symfony.www.workflow.transition_blocker.not_applicable';
+    const REASON_CODE_UNKNOWN = 'com.symfony.www.workflow.transition_blocker.unknown';
 
     private $message;
     private $code;
@@ -71,6 +72,24 @@ public static function createNotApplicable(string $transitionName)
         );
     }
 
+    /**
+     * Create a blocker, that says the transition cannot be made because of unknown
+     * reason.
+     *
+     * This blocker code is chiefly for preserving backwards compatibility.
+     *
+     * @param string $transitionName
+     *
+     * @return static
+     */
+    public static function createUnknownReason(string $transitionName)
+    {
+        return new static(
+            sprintf('Transition "%s" cannot be made, because of unknown reason.', $transitionName),
+            self::REASON_CODE_UNKNOWN
+        );
+    }
+
     /**
      * Converts the blocker into a string for debugging purposes.
      *

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,6 @@`
`22`	`22`	`*/`
`23`	`23`	`class GuardEvent extends Event`
`24`	`24`	`{`
`25`		`- private $blocked = false;`
`26`	`25`	`private $transitionBlockerList;`
`27`	`26`
`28`	`27`	`/**`
`@@ -37,12 +36,17 @@ public function __construct($subject, Marking $marking, Transition $transition,`
`37`	`36`
`38`	`37`	`public function isBlocked()`
`39`	`38`	`{`
`40`		`- return $this->blocked;`
	`39`	`+ return 0 !== count($this->transitionBlockerList);`
`41`	`40`	`}`
`42`	`41`
`43`	`42`	`public function setBlocked($blocked)`
`44`	`43`	`{`
`45`		`- $this->blocked = (bool) $blocked;`
	`44`	`+ if (!$blocked) {`
	`45`	`+ $this->transitionBlockerList = new TransitionBlockerList();`
	`46`	`+ return;`
	`47`	`+ }`
	`48`	`+`
	`49`	`+ $this->transitionBlockerList->add(TransitionBlocker::createUnknownReason($this->getTransition()->getName()));`
`46`	`50`	`}`
`47`	`51`
`48`	`52`	`/**`
`@@ -58,7 +62,5 @@ public function getTransitionBlockerList()`
`58`	`62`	`public function addTransitionBlocker(TransitionBlocker $transitionBlocker)`
`59`	`63`	`{`
`60`	`64`	`$this->transitionBlockerList->add($transitionBlocker);`
`61`		`-`
`62`		`- $this->setBlocked(true);`
`63`	`65`	`}`
`64`	`66`	`}`