[FEATURE] Add Event.registrationPossibleByDate (#4031)

oliverklee · Jan 7, 2025 · 066aa40 · 066aa40
1 parent 56e51ba
commit 066aa40
Show file tree

Hide file tree

Showing 8 changed files with 164 additions and 0 deletions.
diff --git a/Classes/Domain/Model/Event/EventDateInterface.php b/Classes/Domain/Model/Event/EventDateInterface.php
@@ -45,6 +45,10 @@ public function getRegistrationDeadline(): ?\DateTime;
 
     public function isRegistrationRequired(): bool;
 
+    public function isRegistrationPossibleByDate(): bool;
+
+    public function setRegistrationPossibleByDate(bool $possible): void;
+
     public function hasWaitingList(): bool;
 
     /**

diff --git a/Classes/Domain/Model/Event/EventDateTrait.php b/Classes/Domain/Model/Event/EventDateTrait.php
@@ -35,6 +35,13 @@ trait EventDateTrait
 
     protected bool $registrationRequired = false;
 
+    /**
+     * This property is expected to be set from the outside by the `RegistationGuard`.
+     *
+     * @Transient
+     */
+    protected ?bool $registrationPossibleByDate = null;
+
     protected bool $waitingList = false;
 
     /**
@@ -196,6 +203,24 @@ public function setRegistrationRequired(bool $registrationRequired): void
         $this->registrationRequired = $registrationRequired;
     }
 
+    /**
+     * @throws \BadMethodCallException if registrationPossibleByDate has not been set yet
+     */
+    public function isRegistrationPossibleByDate(): bool
+    {
+        $possible = $this->registrationPossibleByDate;
+        if (!\is_bool($possible)) {
+            throw new \BadMethodCallException('registrationPossibleByDate has not been set set.', 1736269500);
+        }
+
+        return $possible;
+    }
+
+    public function setRegistrationPossibleByDate(bool $possible): void
+    {
+        $this->registrationPossibleByDate = $possible;
+    }
+
     public function hasWaitingList(): bool
     {
         return $this->waitingList;

diff --git a/Classes/Domain/Model/Event/EventTopic.php b/Classes/Domain/Model/Event/EventTopic.php
@@ -21,4 +21,9 @@ public function getStatistics(): ?EventStatistics
     {
         return null;
     }
+
+    public function isRegistrationPossibleByDate(): bool
+    {
+        return false;
+    }
 }
diff --git a/Classes/Service/RegistrationGuard.php b/Classes/Service/RegistrationGuard.php
@@ -100,6 +100,16 @@ public function isRegistrationPossibleByDate(EventDateInterface $event): bool
         return $registrationIsEarlyEnough && $registrationIsLateEnough;
     }
 
+    /**
+     * @param array<EventDateInterface> $events
+     */
+    public function setRegistrationPossibleByDateForEvents(array $events): void
+    {
+        foreach ($events as $event) {
+            $event->setRegistrationPossibleByDate($this->isRegistrationPossibleByDate($event));
+        }
+    }
+
     private function getRegistrationDeadlineForEvent(EventDateInterface $event): ?\DateTime
     {
         if ($event->getStart() === null && $event->getRegistrationDeadline() === null) {

diff --git a/Tests/Unit/Domain/Model/Event/EventDateTest.php b/Tests/Unit/Domain/Model/Event/EventDateTest.php
@@ -1382,4 +1382,38 @@ public function getCityNamesSortsCityNames(): void
 
         self::assertSame([$cityName2, $cityName1], $result);
     }
+
+    /**
+     * @test
+     */
+    public function isRegistrationPossibleByDateInitiallyThrowsException(): void
+    {
+        $this->expectException(\BadMethodCallException::class);
+        $this->expectExceptionMessage('registrationPossibleByDate has not been set set.');
+        $this->expectExceptionCode(1736269500);
+
+        $this->subject->isRegistrationPossibleByDate();
+    }
+
+    /**
+     * @return array<string, array{0: bool}>
+     */
+    public static function booleanDataProvider(): array
+    {
+        return [
+            'true' => [true],
+            'false' => [false],
+        ];
+    }
+
+    /**
+     * @test
+     * @dataProvider booleanDataProvider
+     */
+    public function setRegistrationPossibleByDateSetsRegistrationPossibleByDate(bool $value): void
+    {
+        $this->subject->setRegistrationPossibleByDate($value);
+
+        self::assertSame($value, $this->subject->isRegistrationPossibleByDate());
+    }
 }
diff --git a/Tests/Unit/Domain/Model/Event/EventTopicTest.php b/Tests/Unit/Domain/Model/Event/EventTopicTest.php
@@ -581,4 +581,12 @@ public function getStatisticsReturnsNull(): void
     {
         self::assertNull($this->subject->getStatistics());
     }
+
+    /**
+     * @test
+     */
+    public function isRegistrationPossibleByDateAlwaysReturnsFalse(): void
+    {
+        self::assertFalse($this->subject->isRegistrationPossibleByDate());
+    }
 }
diff --git a/Tests/Unit/Domain/Model/Event/SingleEventTest.php b/Tests/Unit/Domain/Model/Event/SingleEventTest.php
@@ -1503,4 +1503,38 @@ public function getCityNamesSortsCityNames(): void
 
         self::assertSame([$cityName2, $cityName1], $result);
     }
+
+    /**
+     * @test
+     */
+    public function isRegistrationPossibleByDateInitiallyThrowsException(): void
+    {
+        $this->expectException(\BadMethodCallException::class);
+        $this->expectExceptionMessage('registrationPossibleByDate has not been set set.');
+        $this->expectExceptionCode(1736269500);
+
+        $this->subject->isRegistrationPossibleByDate();
+    }
+
+    /**
+     * @return array<string, array{0: bool}>
+     */
+    public static function booleanDataProvider(): array
+    {
+        return [
+            'true' => [true],
+            'false' => [false],
+        ];
+    }
+
+    /**
+     * @test
+     * @dataProvider booleanDataProvider
+     */
+    public function setRegistrationPossibleByDateSetsRegistrationPossibleByDate(bool $value): void
+    {
+        $this->subject->setRegistrationPossibleByDate($value);
+
+        self::assertSame($value, $this->subject->isRegistrationPossibleByDate());
+    }
 }
diff --git a/Tests/Unit/Service/RegistrationGuardTest.php b/Tests/Unit/Service/RegistrationGuardTest.php
@@ -398,6 +398,50 @@ public function isRegistrationPossibleByDateForSingleEventWithRegistrationNotPos
         self::assertFalse($this->subject->isRegistrationPossibleByDate($event));
     }
 
+    /**
+     * @test
+     *
+     * @dataProvider registrationPossibleDataProvider
+     */
+    public function setRegistrationPossibleByDateForEventsCanSetTruePossibilityForGivenEvents(
+        ?\DateTime $start,
+        ?\DateTime $registrationStart,
+        ?\DateTime $registrationDeadline
+    ): void {
+        $this->contextMock->method('getPropertyFromAspect')->with('date', 'full')->willReturn($this->now());
+
+        $event = new SingleEvent();
+        $event->setStart($start);
+        $event->setRegistrationStart($registrationStart);
+        $event->setRegistrationDeadline($registrationDeadline);
+
+        $this->subject->setRegistrationPossibleByDateForEvents([$event]);
+
+        self::assertTrue($event->isRegistrationPossibleByDate());
+    }
+
+    /**
+     * @test
+     *
+     * @dataProvider registrationNotPossibleDataProvider
+     */
+    public function setRegistrationPossibleByDateForEventsCanSetFalsePossibilityForGivenEvents(
+        ?\DateTime $start,
+        ?\DateTime $registrationStart,
+        ?\DateTime $registrationDeadline
+    ): void {
+        $this->contextMock->method('getPropertyFromAspect')->with('date', 'full')->willReturn($this->now());
+
+        $event = new SingleEvent();
+        $event->setStart($start);
+        $event->setRegistrationStart($registrationStart);
+        $event->setRegistrationDeadline($registrationDeadline);
+
+        $this->subject->setRegistrationPossibleByDateForEvents([$event]);
+
+        self::assertFalse($event->isRegistrationPossibleByDate());
+    }
+
     /**
      * @test
      */