Add signature functionality to workflow entities

Created new files to add signature functionality to the workflow entities, including signature state enums and signature metadata. Added these changes to the migration script as well. Updated EntityWorkflowStep to include a collection for signatures.

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

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\MainBundle\Entity\Workflow;
+
+enum EntityWorkflowSignatureStateEnum: string
+{
+    case PENDING = 'pending';
+    case SIGNED = 'signed';
+    case REJECTED = 'rejected';
+    case CANCELED = 'canceled';
+}

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

@@ -42,19 +42,25 @@ class EntityWorkflowStep
     private array $destEmail = [];
 
     /**
-     * @var Collection<User>
+     * @var Collection<int, User>
      */
     #[ORM\ManyToMany(targetEntity: User::class)]
     #[ORM\JoinTable(name: 'chill_main_workflow_entity_step_user')]
     private Collection $destUser;
 
     /**
-     * @var Collection<User>
+     * @var Collection<int, User>
      */
     #[ORM\ManyToMany(targetEntity: User::class)]
     #[ORM\JoinTable(name: 'chill_main_workflow_entity_step_user_by_accesskey')]
     private Collection $destUserByAccessKey;
 
+    /**
+     * @var Collection <int, EntityWorkflowStepSignature>
+     */
+    #[ORM\OneToMany(mappedBy: 'step', targetEntity: EntityWorkflowStepSignature::class, cascade: ['persist'], orphanRemoval: true)]
+    private Collection $signatures;
+
     #[ORM\ManyToOne(targetEntity: EntityWorkflow::class, inversedBy: 'steps')]
     private ?EntityWorkflow $entityWorkflow = null;
 
@@ -97,6 +103,7 @@ class EntityWorkflowStep
         $this->ccUser = new ArrayCollection();
         $this->destUser = new ArrayCollection();
         $this->destUserByAccessKey = new ArrayCollection();
+        $this->signatures = new ArrayCollection();
         $this->accessKey = bin2hex(openssl_random_pseudo_bytes(32));
     }
 
@@ -136,6 +143,29 @@ class EntityWorkflowStep
         return $this;
     }
 
+    /**
+     * @internal use @see{EntityWorkflowStepSignature}'s constructor instead
+     */
+    public function addSignature(EntityWorkflowStepSignature $signature): self
+    {
+        if (!$this->signatures->contains($signature)) {
+            $this->signatures[] = $signature;
+        }
+
+        return $this;
+    }
+
+    public function removeSignature(EntityWorkflowStepSignature $signature): self
+    {
+        if ($this->signatures->contains($signature)) {
+            $this->signatures->removeElement($signature);
+        }
+
+        $signature->detachEntityWorkflowStep();
+
+        return $this;
+    }
+
     public function getAccessKey(): string
     {
         return $this->accessKey;
@@ -198,6 +228,14 @@ class EntityWorkflowStep
         return $this->entityWorkflow;
     }
 
+    /**
+     * @return Collection<int, EntityWorkflowStepSignature>
+     */
+    public function getSignatures(): Collection
+    {
+        return $this->signatures;
+    }
+
     public function getId(): ?int
     {
         return $this->id;

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

@@ -0,0 +1,156 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\MainBundle\Entity\Workflow;
+
+use Chill\MainBundle\Doctrine\Model\TrackCreationInterface;
+use Chill\MainBundle\Doctrine\Model\TrackCreationTrait;
+use Chill\MainBundle\Doctrine\Model\TrackUpdateInterface;
+use Chill\MainBundle\Doctrine\Model\TrackUpdateTrait;
+use Chill\MainBundle\Entity\User;
+use Chill\PersonBundle\Entity\Person;
+use Doctrine\ORM\Mapping as ORM;
+
+#[ORM\Entity]
+#[ORM\Table(name: 'chill_main_workflow_entity_step_signature')]
+class EntityWorkflowStepSignature implements TrackCreationInterface, TrackUpdateInterface
+{
+    use TrackCreationTrait;
+    use TrackUpdateTrait;
+
+    #[ORM\Id]
+    #[ORM\Column(type: \Doctrine\DBAL\Types\Types::INTEGER, unique: true)]
+    #[ORM\GeneratedValue(strategy: 'AUTO')]
+    private ?int $id = null;
+
+    #[ORM\ManyToOne(targetEntity: User::class)]
+    #[ORM\JoinColumn(nullable: true)]
+    private ?User $userSigner = null;
+
+    #[ORM\ManyToOne(targetEntity: Person::class)]
+    #[ORM\JoinColumn(nullable: true)]
+    private ?Person $personSigner = null;
+
+    #[ORM\Column(type: \Doctrine\DBAL\Types\Types::STRING, length: 50, nullable: false, enumType: EntityWorkflowSignatureStateEnum::class)]
+    private EntityWorkflowSignatureStateEnum $state = EntityWorkflowSignatureStateEnum::PENDING;
+
+    #[ORM\Column(type: \Doctrine\DBAL\Types\Types::DATETIMETZ_IMMUTABLE, nullable: true, options: ['default' => null])]
+    private ?\DateTimeImmutable $stateDate = null;
+
+    #[ORM\Column(type: \Doctrine\DBAL\Types\Types::JSON, nullable: false, options: ['default' => '[]'])]
+    private array $signatureMetadata = [];
+
+    #[ORM\Column(type: \Doctrine\DBAL\Types\Types::INTEGER, nullable: true, options: ['default' => null])]
+    private ?int $zoneSignatureIndex = null;
+
+    #[ORM\ManyToOne(targetEntity: EntityWorkflowStep::class, inversedBy: 'signatures')]
+    #[ORM\JoinColumn(nullable: false)]
+    private ?EntityWorkflowStep $step = null;
+
+    public function __construct(
+        EntityWorkflowStep $step,
+        User|Person $signer,
+    ) {
+        $this->step = $step;
+        $step->addSignature($this);
+        $this->setSigner($signer);
+    }
+
+    private function setSigner(User|Person $signer): void
+    {
+        if ($signer instanceof User) {
+            $this->userSigner = $signer;
+        } else {
+            $this->personSigner = $signer;
+        }
+    }
+
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+
+    public function getStep(): EntityWorkflowStep
+    {
+        return $this->step;
+    }
+
+    public function getSigner(): User|Person
+    {
+        if (null !== $this->userSigner) {
+            return $this->userSigner;
+        }
+
+        return $this->personSigner;
+    }
+
+    public function getSignatureMetadata(): array
+    {
+        return $this->signatureMetadata;
+    }
+
+    public function setSignatureMetadata(array $signatureMetadata): EntityWorkflowStepSignature
+    {
+        $this->signatureMetadata = $signatureMetadata;
+
+        return $this;
+    }
+
+    public function getState(): EntityWorkflowSignatureStateEnum
+    {
+        return $this->state;
+    }
+
+    public function setState(EntityWorkflowSignatureStateEnum $state): EntityWorkflowStepSignature
+    {
+        $this->state = $state;
+
+        return $this;
+    }
+
+    public function getStateDate(): ?\DateTimeImmutable
+    {
+        return $this->stateDate;
+    }
+
+    public function setStateDate(?\DateTimeImmutable $stateDate): EntityWorkflowStepSignature
+    {
+        $this->stateDate = $stateDate;
+
+        return $this;
+    }
+
+    public function getZoneSignatureIndex(): ?int
+    {
+        return $this->zoneSignatureIndex;
+    }
+
+    public function setZoneSignatureIndex(?int $zoneSignatureIndex): EntityWorkflowStepSignature
+    {
+        $this->zoneSignatureIndex = $zoneSignatureIndex;
+
+        return $this;
+    }
+
+    /**
+     * Detach from the @see{EntityWorkflowStep}.
+     *
+     * @internal used internally to remove the current signature
+     *
+     * @return $this
+     */
+    public function detachEntityWorkflowStep(): self
+    {
+        $this->step = null;
+
+        return $this;
+    }
+}