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

src/Bundle/ChillPersonBundle/Entity/AccompanyingPeriod.php

@@ -21,6 +21,7 @@ use Chill\MainBundle\Entity\Location;
 use Chill\MainBundle\Entity\Scope;
 use Chill\MainBundle\Entity\User;
 use Chill\MainBundle\Entity\UserJob;
+use Chill\PersonBundle\Entity\AccompanyingPeriod\AccompanyingPeriodLocationHistory;
 use Chill\PersonBundle\Entity\AccompanyingPeriod\AccompanyingPeriodWork;
 use Chill\PersonBundle\Entity\AccompanyingPeriod\ClosingMotive;
 use Chill\PersonBundle\Entity\AccompanyingPeriod\Comment;
@@ -37,17 +38,19 @@ use DateTimeImmutable;
 use DateTimeInterface;
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
+use Doctrine\Common\Collections\Criteria;
 use Doctrine\ORM\Mapping as ORM;
+use Iterator;
 use LogicException;
 use Symfony\Component\Serializer\Annotation\DiscriminatorMap;
 use Symfony\Component\Serializer\Annotation\Groups;
 use Symfony\Component\Validator\Constraints as Assert;
 use Symfony\Component\Validator\Context\ExecutionContextInterface;
 use Symfony\Component\Validator\GroupSequenceProviderInterface;
+
 use UnexpectedValueException;
 
 use function in_array;
-
 use const SORT_REGULAR;
 
 /**
@@ -207,6 +210,12 @@ class AccompanyingPeriod implements
      */
     private ?UserJob $job = null;
 
+    /**
+     * @ORM\OneToMany(targetEntity=AccompanyingPeriodLocationHistory::class,
+     * mappedBy="period", cascade={"persist", "remove"}, orphanRemoval=true)
+     */
+    private Collection $locationHistories;
+
     /**
      * @var DateTime
      *
@@ -379,6 +388,7 @@ class AccompanyingPeriod implements
         $this->works = new ArrayCollection();
         $this->resources = new ArrayCollection();
         $this->userHistories = new ArrayCollection();
+        $this->locationHistories = new ArrayCollection();
     }
 
     /**
@@ -429,6 +439,39 @@ class AccompanyingPeriod implements
         return $this;
     }
 
+    public function addLocationHistory(AccompanyingPeriodLocationHistory $history): self
+    {
+        if ($this->getStep() === self::STEP_DRAFT) {
+            return $this;
+        }
+
+        if (!$this->locationHistories->contains($history)) {
+            $this->locationHistories[] = $history;
+            $history->setPeriod($this);
+        }
+
+        // ensure continuity of histories
+        $criteria = new Criteria();
+        $criteria->orderBy(['startDate' => Criteria::ASC, 'id' => Criteria::ASC]);
+
+        /** @var Iterator $locations */
+        $locations = $this->getLocationHistories()->matching($criteria)->getIterator();
+        $locations->rewind();
+
+        do {
+            /** @var AccompanyingPeriodLocationHistory $current */
+            $current = $locations->current();
+            $locations->next();
+
+            if ($locations->valid()) {
+                $next = $locations->current();
+                $current->setEndDate($next->getStartDate());
+            }
+        } while ($locations->valid());
+
+        return $this;
+    }
+
     public function addPerson(?Person $person = null): self
     {
         if (null !== $person) {
@@ -661,6 +704,17 @@ class AccompanyingPeriod implements
         return $this->job;
     }
 
+    public function getLastLocationHistory(): ?AccompanyingPeriodLocationHistory
+    {
+        foreach ($this->getLocationHistories() as $locationHistory) {
+            if (null === $locationHistory->getEndDate()) {
+                return $locationHistory;
+            }
+        }
+
+        return null;
+    }
+
     /**
      * Get the location, taking precedence into account.
      *
@@ -675,6 +729,14 @@ class AccompanyingPeriod implements
         return $this->getAddressLocation();
     }
 
+    /**
+     * @return Collection|AccompanyingPeriodLocationHistory[]
+     */
+    public function getLocationHistories(): Collection
+    {
+        return $this->locationHistories;
+    }
+
     /**
      * Get where the location is.
      *
@@ -977,6 +1039,15 @@ class AccompanyingPeriod implements
         $this->comments->removeElement($comment);
     }
 
+    public function removeLocationHistory(AccompanyingPeriodLocationHistory $history): self
+    {
+        if ($this->locationHistories->removeElement($history)) {
+            $history->setPeriod(null);
+        }
+
+        return $this;
+    }
+
     /**
      * Remove Participation.
      */
@@ -1031,7 +1102,18 @@ class AccompanyingPeriod implements
      */
     public function setAddressLocation(?Address $addressLocation = null): self
     {
-        $this->addressLocation = $addressLocation;
+        if ($this->addressLocation !== $addressLocation) {
+            $this->addressLocation = $addressLocation;
+
+            if (null !== $addressLocation) {
+                $locationHistory = new AccompanyingPeriodLocationHistory();
+                $locationHistory
+                    ->setStartDate(new DateTimeImmutable('now'))
+                    ->setAddressLocation($addressLocation);
+
+                $this->addLocationHistory($locationHistory);
+            }
+        }
 
         return $this;
     }
@@ -1134,7 +1216,18 @@ class AccompanyingPeriod implements
      */
     public function setPersonLocation(?Person $person = null): self
     {
-        $this->personLocation = $person;
+        if ($this->personLocation !== $person) {
+            $this->personLocation = $person;
+
+            if (null !== $person) {
+                $locationHistory = new AccompanyingPeriodLocationHistory();
+                $locationHistory
+                    ->setStartDate(new DateTimeImmutable('now'))
+                    ->setPersonLocation($person);
+
+                $this->addLocationHistory($locationHistory);
+            }
+        }
 
         return $this;
     }
@@ -1201,8 +1294,14 @@ class AccompanyingPeriod implements
 
     public function setStep(string $step): self
     {
+        $previous = $this->step;
+
         $this->step = $step;
 
+        if (self::STEP_DRAFT === $previous && self::STEP_DRAFT !== $step) {
+            $this->bootPeriod();
+        }
+
         return $this;
     }
 
@@ -1241,6 +1340,17 @@ class AccompanyingPeriod implements
         return $this;
     }
 
+    private function bootPeriod(): void
+    {
+        // first location history
+        $locationHistory = new AccompanyingPeriodLocationHistory();
+        $locationHistory
+            ->setStartDate(new DateTimeImmutable('now'))
+            ->setPersonLocation($this->getPersonLocation())
+            ->setAddressLocation($this->getAddressLocation());
+        $this->addLocationHistory($locationHistory);
+    }
+
     private function setRequestorPerson(?Person $requestorPerson = null): self
     {
         $this->requestorPerson = $requestorPerson;