workflow: allow a user to get access to validation step by an access key

src/Bundle/ChillMainBundle/Entity/Workflow/EntityWorkflowStep.php

@@ -27,6 +27,11 @@ use function in_array;
  */
 class EntityWorkflowStep
 {
+    /**
+     * @ORM\Column(type="text", nullable=false)
+     */
+    private string $accessKey;
+
     /**
      * @ORM\Column(type="text", options={"default": ""})
      */
@@ -48,6 +53,12 @@ class EntityWorkflowStep
      */
     private Collection $destUser;
 
+    /**
+     * @ORM\ManyToMany(targetEntity=User::class)
+     * @ORM\JoinTable(name="chill_main_workflow_entity_step_user_by_accesskey")
+     */
+    private Collection $destUserByAccessKey;
+
     /**
      * @ORM\ManyToOne(targetEntity=EntityWorkflow::class, inversedBy="steps")
      */
@@ -101,14 +112,10 @@ class EntityWorkflowStep
      */
     private ?string $transitionByEmail = null;
 
-    /**
-     * @ORM\Column(type="text", nullable=false)
-     */
-    private string $accessKey;
-
     public function __construct()
     {
         $this->destUser = new ArrayCollection();
+        $this->destUserByAccessKey = new ArrayCollection();
         $this->accessKey = bin2hex(openssl_random_pseudo_bytes(32));
     }
 
@@ -133,6 +140,37 @@ class EntityWorkflowStep
         return $this;
     }
 
+    public function addDestUserByAccessKey(User $user): self
+    {
+        if (!$this->destUserByAccessKey->contains($user)) {
+            $this->destUserByAccessKey[] = $user;
+            $this->getEntityWorkflow()
+                ->addSubscriberToFinal($user)
+                ->addSubscriberToStep($user);
+        }
+
+        return $this;
+    }
+
+    public function getAccessKey(): string
+    {
+        return $this->accessKey;
+    }
+
+    /**
+     * get all the users which are allowed to apply a transition: those added manually, and
+     * those added automatically bu using an access key.
+     */
+    public function getAllDestUser(): Collection
+    {
+        return new ArrayCollection(
+            [
+                ...$this->getDestUser()->toArray(),
+                ...$this->getDestUserByAccessKey()->toArray(),
+            ]
+        );
+    }
+
     public function getComment(): string
     {
         return $this->comment;
@@ -149,13 +187,21 @@ class EntityWorkflowStep
     }
 
     /**
-     * @return ArrayCollection|Collection
+     * get dest users added by the creator.
+     *
+     * You should **not** rely on this method to get all users which are able to
+     * apply a transition on this step. Use @see{EntityWorkflowStep::getAllDestUser} instead.
      */
-    public function getDestUser()
+    public function getDestUser(): collection
     {
         return $this->destUser;
     }
 
+    public function getDestUserByAccessKey(): Collection
+    {
+        return $this->destUserByAccessKey;
+    }
+
     public function getEntityWorkflow(): ?EntityWorkflow
     {
         return $this->entityWorkflow;
@@ -206,6 +252,19 @@ class EntityWorkflowStep
         return $this->freezeAfter;
     }
 
+    public function isWaitingForTransition(): bool
+    {
+        if (null !== $this->transitionAfter) {
+            return false;
+        }
+
+        if ($this->isFinal()) {
+            return false;
+        }
+
+        return true;
+    }
+
     public function removeDestEmail(string $email): self
     {
         $this->destEmail = array_filter($this->destEmail, static function (string $existing) use ($email) {
@@ -222,6 +281,13 @@ class EntityWorkflowStep
         return $this;
     }
 
+    public function removeDestUserByAccessKey(User $user): self
+    {
+        $this->destUserByAccessKey->removeElement($user);
+
+        return $this;
+    }
+
     public function setComment(?string $comment): EntityWorkflowStep
     {
         $this->comment = (string) $comment;