[person] Feature: add a person's center history

The association between Person and Center is now stored in a dedicated
Entity: `PersonCenterHistory`, which have a date interval (start date
and endDate). The SQL counterpart is a table, with a constraint which
ensure that no person might be associated with two center at the same time.

For ease, a view is created to get the current center associated with
the person.

The dedicated migration creates also:

* indexes for a rapid search for person at current date;
* and populate the table from current data, setting the startdate to the
  person's creation date and time if any, `NOW()` unless.

The `Person` entity is also updated to use the information from the
PersonCenterHistory classes, but this commit does not yet delete the
`Center` column.

src/Bundle/ChillPersonBundle/Entity/Person.php

@@ -27,6 +27,8 @@ use Chill\MainBundle\Validation\Constraint\PhonenumberConstraint;
 use Chill\PersonBundle\Entity\Household\Household;
 use Chill\PersonBundle\Entity\Household\HouseholdMember;
 use Chill\PersonBundle\Entity\Household\PersonHouseholdAddress;
+use Chill\PersonBundle\Entity\Person\PersonCenterCurrent;
+use Chill\PersonBundle\Entity\Person\PersonCenterHistory;
 use Chill\PersonBundle\Entity\Person\PersonCurrentAddress;
 use Chill\PersonBundle\Entity\Person\PersonResource;
 use Chill\PersonBundle\Validator\Constraints\Household\HouseholdMembershipSequential;
@@ -180,9 +182,21 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI
      * The person's center.
      *
      * @ORM\ManyToOne(targetEntity="Chill\MainBundle\Entity\Center")
+     * @deprecated
      */
     private ?Center $center = null;
 
+    /**
+     * @ORM\OneToMany(targetEntity=PersonCenterHistory::class, mappedBy="person")
+     * @var Collection|PersonCenterHistory[]
+     */
+    private Collection $centerHistory;
+
+    /**
+     * @ORM\OneToOne(targetEntity=PersonCenterCurrent::class, mappedBy="person")
+     */
+    private ?PersonCenterCurrent $centerCurrent = null;
+
     /**
      * Array where customfield's data are stored.
      *
@@ -523,6 +537,7 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI
         $this->budgetResources = new ArrayCollection();
         $this->budgetCharges = new ArrayCollection();
         $this->resources = new ArrayCollection();
+        $this->centerHistory = new ArrayCollection();
     }
 
     /**
@@ -897,7 +912,7 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI
 
     public function getCenter(): ?Center
     {
-        return $this->center;
+        return null === $this->centerCurrent ? null : $this->centerCurrent->getCenter();
     }
 
     public function getCFData(): ?array
@@ -1510,17 +1525,60 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI
         return $this;
     }
 
+    /**
+     * Associate the center with the person. The association start on 'now'.
+     *
+     * @param Center $center
+     * @return $this
+     */
     public function setCenter(Center $center): self
     {
         $this->center = $center;
 
+        $modification = new DateTimeImmutable('now');
+
+        foreach ($this->centerHistory as $centerHistory) {
+            if (null === $centerHistory->getEndDate()) {
+                $centerHistory->setEndDate($modification);
+            }
+        }
+
+        $this->centerHistory[] = $new = new PersonCenterHistory($this, $center, $modification);
+        $this->centerCurrent = new PersonCenterCurrent($new);
+
         return $this;
     }
 
     /**
-     * @return Report
+     * @return Collection
      */
-    public function setCFData(?array $cFData)
+    public function getCenterHistory(): Collection
+    {
+        return $this->centerHistory;
+    }
+
+    /**
+     * @param Collection $centerHistory
+     * @return Person
+     */
+    public function setCenterHistory(Collection $centerHistory): Person
+    {
+        $this->centerHistory = $centerHistory;
+        return $this;
+    }
+
+    /**
+     * @return PersonCenterCurrent|null
+     */
+    public function getCenterCurrent(): ?PersonCenterCurrent
+    {
+        return $this->centerCurrent;
+    }
+
+    /**
+     * @return Person
+     */
+    public function setCFData(?array $cFData): self
     {
         $this->cFData = $cFData;
 

src/Bundle/ChillPersonBundle/Entity/Person/PersonCenterCurrent.php

@@ -0,0 +1,112 @@
+<?php
+
+namespace Chill\PersonBundle\Entity\Person;
+
+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\Center;
+use Chill\MainBundle\Entity\User;
+use Chill\PersonBundle\Entity\Person;
+use DateTimeInterface;
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * Associate a Person with the current center.
+ *
+ * The process of selecting the current center is done on database side,
+ * using a SQL view.
+ *
+ * @ORM\Entity(readOnly=true)
+ * @ORM\Table(name="view_chill_person_person_center_history_current")
+ * @psalm-internal Chill\PersonBundle\Entity
+ */
+class PersonCenterCurrent
+{
+    /**
+     * @ORM\Id
+     * @ORM\Column(type="integer")
+     */
+    private ?int $id = null;
+
+    /**
+     * @ORM\ManyToOne(targetEntity=Person::class, inversedBy="centerCurrent")
+     */
+    private Person $person;
+
+    /**
+     * @ORM\ManyToOne(targetEntity=Center::class)
+     */
+    private Center $center;
+
+    /**
+     * @ORM\Column(type="date_immutable", nullable=false)
+     */
+    private \DateTimeImmutable $startDate;
+
+    /**
+     * @ORM\Column(type="date_immutable", nullable=true, options={"default": null})
+     */
+    private ?\DateTimeImmutable $endDate = null;
+
+    /**
+     * Populate the properties person, center, start and end date from history.
+     *
+     * The creator and updatedby are not filled.
+     *
+     * @internal Should not be instantied, unless inside Person entity
+     * @param PersonCenterHistory $history
+     */
+    public function __construct(PersonCenterHistory $history)
+    {
+        $this->person = $history->getPerson();
+        $this->center = $history->getCenter();
+        $this->startDate = $history->getStartDate();
+        $this->endDate = $history->getEndDate();
+        $this->id = $history->getId();
+    }
+
+    /**
+     * The id will be the same as the current @link{PersonCenterHistory::class}
+     *
+     * @return int
+     */
+    public function getId(): int
+    {
+        return $this->id;
+    }
+
+    /**
+     * @return Person
+     */
+    public function getPerson(): Person
+    {
+        return $this->person;
+    }
+
+    /**
+     * @return Center
+     */
+    public function getCenter(): Center
+    {
+        return $this->center;
+    }
+
+    /**
+     * @return \DateTimeImmutable
+     */
+    public function getStartDate(): \DateTimeImmutable
+    {
+        return $this->startDate;
+    }
+
+    /**
+     * @return \DateTimeImmutable|null
+     */
+    public function getEndDate(): ?\DateTimeImmutable
+    {
+        return $this->endDate;
+    }
+
+}

src/Bundle/ChillPersonBundle/Entity/Person/PersonCenterHistory.php

@@ -0,0 +1,142 @@
+<?php
+
+namespace Chill\PersonBundle\Entity\Person;
+
+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\Center;
+use Chill\PersonBundle\Entity\Person;
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * Associate a Person with a Center. The association may change on date intervals
+ *
+ * @ORM\Entity
+ * @ORM\Table(name="chill_person_person_center_history")
+ */
+class PersonCenterHistory implements TrackCreationInterface, TrackUpdateInterface
+{
+    use TrackCreationTrait;
+    use TrackUpdateTrait;
+
+    /**
+     * @ORM\Id
+     * @ORM\GeneratedValue
+     * @ORM\Column(type="integer")
+     */
+    private ?int $id = null;
+
+    /**
+     * @ORM\ManyToOne(targetEntity=Person::class, inversedBy="centerHistory")
+     */
+    private ?Person $person = null;
+
+    /**
+     * @ORM\ManyToOne(targetEntity=Center::class)
+     */
+    private ?Center $center = null;
+
+    /**
+     * @ORM\Column(type="date_immutable", nullable=false)
+     */
+    private ?\DateTimeImmutable $startDate = null;
+
+    /**
+     * @ORM\Column(type="date_immutable", nullable=true, options={"default": null})
+     */
+    private ?\DateTimeImmutable $endDate = null;
+
+    /**
+     * @param Person|null $person
+     * @param Center|null $center
+     * @param \DateTimeImmutable|null $startDate
+     */
+    public function __construct(?Person $person = null, ?Center $center = null, ?\DateTimeImmutable $startDate = null)
+    {
+        $this->person = $person;
+        $this->center = $center;
+        $this->startDate = $startDate;
+    }
+
+
+    /**
+     * @return int|null
+     */
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+
+    /**
+     * @return Person|null
+     */
+    public function getPerson(): ?Person
+    {
+        return $this->person;
+    }
+
+    /**
+     * @param Person|null $person
+     */
+    public function setPerson(?Person $person): self
+    {
+        $this->person = $person;
+
+        return $this;
+    }
+
+    /**
+     * @return Center|null
+     */
+    public function getCenter(): ?Center
+    {
+        return $this->center;
+    }
+
+    /**
+     * @param Center|null $center
+     */
+    public function setCenter(?Center $center): self
+    {
+        $this->center = $center;
+
+        return $this;
+    }
+
+    /**
+     * @return \DateTimeImmutable|null
+     */
+    public function getStartDate(): ?\DateTimeImmutable
+    {
+        return $this->startDate;
+    }
+
+    /**
+     * @param \DateTimeImmutable|null $startDate
+     */
+    public function setStartDate(?\DateTimeImmutable $startDate): self
+    {
+        $this->startDate = $startDate;
+        return $this;
+    }
+
+    /**
+     * @return \DateTimeImmutable|null
+     */
+    public function getEndDate(): ?\DateTimeImmutable
+    {
+        return $this->endDate;
+    }
+
+    /**
+     * @param \DateTimeImmutable|null $endDate
+     */
+    public function setEndDate(?\DateTimeImmutable $endDate): self
+    {
+        $this->endDate = $endDate;
+
+        return $this;
+    }
+}