Update schema to store accompanying period work referrer history

src/Bundle/ChillPersonBundle/Entity/AccompanyingPeriod/AccompanyingPeriodWork.php

@@ -26,6 +26,7 @@ use DateTimeImmutable;
 use DateTimeInterface;
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
+use Doctrine\Common\Collections\ReadableCollection;
 use Doctrine\ORM\Mapping as ORM;
 use LogicException;
 use Symfony\Component\Serializer\Annotation as Serializer;
@@ -154,14 +155,11 @@ class AccompanyingPeriodWork implements AccompanyingPeriodLinkedWithSocialIssues
     private PrivateCommentEmbeddable $privateComment;
 
     /**
-     * @var Collection<User>
-     * @ORM\ManyToMany(targetEntity=User::class)
+     * @var Collection<int, AccompanyingPeriodWorkReferrerHistory>
+     * @ORM\OneToMany(targetEntity=AccompanyingPeriodWorkReferrerHistory::class, cascade={"persist", "remove"}, mappedBy="accompanyingPeriodWork")
      * @ORM\JoinTable(name="chill_person_accompanying_period_work_referrer")
-     * @Serializer\Groups({"read", "docgen:read", "read:accompanyingPeriodWork:light"})
-     * @Serializer\Groups({"accompanying_period_work:edit"})
-     * @Serializer\Groups({"accompanying_period_work:create"})
      */
-    private Collection $referrers;
+    private Collection $referrersHistory;
 
     /**
      * @var Collection<Result>
@@ -220,7 +218,7 @@ class AccompanyingPeriodWork implements AccompanyingPeriodLinkedWithSocialIssues
         $this->thirdParties = new ArrayCollection();
         $this->persons = new ArrayCollection();
         $this->accompanyingPeriodWorkEvaluations = new ArrayCollection();
-        $this->referrers = new ArrayCollection();
+        $this->referrersHistory = new ArrayCollection();
     }
 
     public function addAccompanyingPeriodWorkEvaluation(AccompanyingPeriodWorkEvaluation $evaluation): self
@@ -254,8 +252,9 @@ class AccompanyingPeriodWork implements AccompanyingPeriodLinkedWithSocialIssues
 
     public function addReferrer(User $referrer): self
     {
-        if (!$this->referrers->contains($referrer)) {
-            $this->referrers[] = $referrer;
+        if (!$this->getReferrers()->contains($referrer)) {
+            $this->referrersHistory[] =
+                new AccompanyingPeriodWorkReferrerHistory($this, $referrer, new DateTimeImmutable('today'));
         }
 
         return $this;
@@ -351,15 +350,18 @@ class AccompanyingPeriodWork implements AccompanyingPeriodLinkedWithSocialIssues
     }
 
     /**
-     * @return Collection|User[]
+     * @return ReadableCollection<int, User>
+     * @Serializer\Groups({"read", "docgen:read", "read:accompanyingPeriodWork:light"})
+     * @Serializer\Groups({"accompanying_period_work:edit"})
+     * @Serializer\Groups({"accompanying_period_work:create"})
      */
-    public function getReferrers(): Collection
+    public function getReferrers(): ReadableCollection
     {
-        return $this->referrers;
+        return $this->referrersHistory->map(fn (AccompanyingPeriodWorkReferrerHistory $h) => $h->getUser());
     }
 
     /**
-     * @return Collection|Result[]
+     * @return Collection<int, Result>
      */
     public function getResults(): Collection
     {
@@ -434,7 +436,15 @@ class AccompanyingPeriodWork implements AccompanyingPeriodLinkedWithSocialIssues
 
     public function removeReferrer(User $referrer): self
     {
-        $this->referrers->removeElement($referrer);
+        foreach ($this->referrersHistory as $history) {
+            if ($history->isOpen() && $referrer === $history->getUser()) {
+                $history->setEndDate(new DateTimeImmutable('today'));
+
+                if ($history->isDateRangeEmpty()) {
+                    $history->removeAccompanyingPeriodWork();
+                }
+            }
+        }
 
         return $this;
     }

src/Bundle/ChillPersonBundle/Entity/AccompanyingPeriod/AccompanyingPeriodWorkReferrerHistory.php

@@ -0,0 +1,125 @@
+<?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\PersonBundle\Entity\AccompanyingPeriod;
+
+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 Doctrine\ORM\Mapping as ORM;
+
+/**
+ * @ORM\Entity
+ * @ORM\Table(name="chill_person_accompanying_period_work_referrer")
+ */
+class AccompanyingPeriodWorkReferrerHistory implements TrackCreationInterface, TrackUpdateInterface
+{
+    use TrackCreationTrait;
+    use TrackUpdateTrait;
+
+    /**
+     * @ORM\Id
+     * @ORM\GeneratedValue
+     * @ORM\Column(type="integer")
+     */
+    private ?int $id = null;
+
+    /**
+     * @var \DateTimeImmutable|null
+     * @ORM\Column(type="date_immutable", nullable=true, options={"default": null})
+     */
+    private ?\DateTimeImmutable $endDate;
+
+    /**
+     * @var AccompanyingPeriodWork|null
+     * @ORM\ManyToOne(targetEntity=AccompanyingPeriodWork::class, inversedBy="referrersHistory")
+     */
+    private ?AccompanyingPeriodWork $accompanyingPeriodWork;
+
+    public function __construct(
+        AccompanyingPeriodWork $accompanyingPeriodWork,
+        /**
+         * @var User
+         * @ORM\ManyToOne(targetEntity=User::class)
+         */
+        private readonly User $user,
+        /**
+         * @var \DateTimeImmutable
+         * @ORM\Column(type="date_immutable", nullable=false)
+         */
+        private readonly \DateTimeImmutable $startDate,
+    ) {
+        $this->accompanyingPeriodWork = $accompanyingPeriodWork;
+    }
+
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+
+    public function getEndDate(): ?\DateTimeImmutable
+    {
+        return $this->endDate;
+    }
+
+    public function setEndDate(?\DateTimeImmutable $endDate): AccompanyingPeriodWorkReferrerHistory
+    {
+        $this->endDate = $endDate;
+        return $this;
+    }
+
+    public function getAccompanyingPeriodWork(): AccompanyingPeriodWork
+    {
+        return $this->accompanyingPeriodWork;
+    }
+
+    public function getUser(): User
+    {
+        return $this->user;
+    }
+
+    public function getStartDate(): \DateTimeImmutable
+    {
+        return $this->startDate;
+    }
+
+    /**
+     * to be used when the history is removed (when startDate = endDate)
+     *
+     * @return self
+     */
+    public function removeAccompanyingPeriodWork(): self
+    {
+        $this->accompanyingPeriodWork = null;
+
+        return $this;
+    }
+
+    /**
+     * @return bool true if the endDate is null
+     */
+    public function isOpen(): bool
+    {
+        return null === $this->getEndDate();
+    }
+
+    /**
+     * return true if the date range is empty (start date and end date are equal).
+     *
+     * @return bool true if the start date and end date are equal.
+     */
+    public function isDateRangeEmpty(): bool
+    {
+        return $this->getStartDate()->format('Y-m-d') === $this->getEndDate()?->format('Y-m-d');
+    }
+}