Merge remote-tracking branch 'origin/master' into issue439_residential_address_otf

src/Bundle/ChillMainBundle/Entity/Location.php

@@ -18,9 +18,9 @@ use Chill\MainBundle\Validation\Constraint\PhonenumberConstraint;
 use DateTimeImmutable;
 use DateTimeInterface;
 use Doctrine\ORM\Mapping as ORM;
+use libphonenumber\PhoneNumber;
 use Symfony\Component\Serializer\Annotation as Serializer;
 use Symfony\Component\Serializer\Annotation\DiscriminatorMap;
-use Symfony\Component\Validator\Constraints as Assert;
 
 /**
  * @ORM\Table(name="chill_main_location")
@@ -90,20 +90,18 @@ class Location implements TrackCreationInterface, TrackUpdateInterface
     private ?string $name = null;
 
     /**
-     * @ORM\Column(type="string", length=64, nullable=true)
+     * @ORM\Column(type="phone_number", nullable=true)
      * @Serializer\Groups({"read", "write", "docgen:read"})
-     * @Assert\Regex(pattern="/^([\+{1}])([0-9\s*]{4,20})$/")
      * @PhonenumberConstraint(type="any")
      */
-    private ?string $phonenumber1 = null;
+    private ?PhoneNumber $phonenumber1 = null;
 
     /**
-     * @ORM\Column(type="string", length=64, nullable=true)
+     * @ORM\Column(type="phone_number", nullable=true)
      * @Serializer\Groups({"read", "write", "docgen:read"})
-     * @Assert\Regex(pattern="/^([\+{1}])([0-9\s*]{4,20})$/")
      * @PhonenumberConstraint(type="any")
      */
-    private ?string $phonenumber2 = null;
+    private ?PhoneNumber $phonenumber2 = null;
 
     /**
      * @ORM\Column(type="datetime_immutable", nullable=true)
@@ -162,12 +160,12 @@ class Location implements TrackCreationInterface, TrackUpdateInterface
         return $this->name;
     }
 
-    public function getPhonenumber1(): ?string
+    public function getPhonenumber1(): ?PhoneNumber
     {
         return $this->phonenumber1;
     }
 
-    public function getPhonenumber2(): ?string
+    public function getPhonenumber2(): ?PhoneNumber
     {
         return $this->phonenumber2;
     }
@@ -238,14 +236,14 @@ class Location implements TrackCreationInterface, TrackUpdateInterface
         return $this;
     }
 
-    public function setPhonenumber1(?string $phonenumber1): self
+    public function setPhonenumber1(?PhoneNumber $phonenumber1): self
     {
         $this->phonenumber1 = $phonenumber1;
 
         return $this;
     }
 
-    public function setPhonenumber2(?string $phonenumber2): self
+    public function setPhonenumber2(?PhoneNumber $phonenumber2): self
     {
         $this->phonenumber2 = $phonenumber2;
 

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

@@ -41,6 +41,17 @@ class EntityWorkflow implements TrackCreationInterface, TrackUpdateInterface
 
     use TrackUpdateTrait;
 
+    /**
+     * a list of future dest emails for the next steps.
+     *
+     * This is in used in order to let controller inform who will be the future emails which will validate
+     * the next step. This is necessary to perform some computation about the next emails, before they are
+     * associated to the entity EntityWorkflowStep.
+     *
+     * @var array|string[]
+     */
+    public array $futureDestEmails = [];
+
     /**
      * a list of future dest users for the next steps.
      *

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")
      */
@@ -86,7 +97,7 @@ class EntityWorkflowStep
     private ?string $transitionAfter = null;
 
     /**
-     * @ORM\Column(type="datetime_immutable")
+     * @ORM\Column(type="datetime_immutable", nullable=true, options={"default": null})
      */
     private ?DateTimeImmutable $transitionAt = null;
 
@@ -104,6 +115,8 @@ class EntityWorkflowStep
     public function __construct()
     {
         $this->destUser = new ArrayCollection();
+        $this->destUserByAccessKey = new ArrayCollection();
+        $this->accessKey = bin2hex(openssl_random_pseudo_bytes(32));
     }
 
     public function addDestEmail(string $email): self
@@ -119,11 +132,45 @@ class EntityWorkflowStep
     {
         if (!$this->destUser->contains($user)) {
             $this->destUser[] = $user;
+            $this->getEntityWorkflow()
+                ->addSubscriberToFinal($user)
+                ->addSubscriberToStep($user);
         }
 
         return $this;
     }
 
+    public function addDestUserByAccessKey(User $user): self
+    {
+        if (!$this->destUserByAccessKey->contains($user) && !$this->destUser->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;
@@ -140,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;
@@ -197,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) {
@@ -213,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;