oliverklee · oliverklee · Jan 14, 2025 · Jan 7, 2025
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,7 +12,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 - Add `Venue.city` property (#3908, #3914)
 - Add a new plugin for the event archive, outlook and single view
   (#3895, #3909, #3910, #3911, #3913, #3915, #3986, #3969, #4024, #4025, #4026,
-  #4027, #4028, #4029, #4030)
+  #4027, #4028, #4029, #4030, #4031, #4033)
 - Re-add the FE editor (#3894, #3903, #3904)
 - Add `EventRepository::findUpcoming()` (#3892, #3904)
 - Add `EventRepository::findInPast()` (#3885, #3887, #3891, #3904)

diff --git a/Classes/Controller/EventController.php b/Classes/Controller/EventController.php
@@ -6,6 +6,8 @@
 
 use OliverKlee\Seminars\Domain\Model\Event\Event;
 use OliverKlee\Seminars\Domain\Repository\Event\EventRepository;
+use OliverKlee\Seminars\Service\EventStatisticsCalculator;
+use OliverKlee\Seminars\Service\RegistrationGuard;
 use Psr\Http\Message\ResponseInterface;
 use TYPO3\CMS\Extbase\Annotation\IgnoreValidation;
 use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;
@@ -17,9 +19,18 @@ class EventController extends ActionController
 {
     protected EventRepository $eventRepository;
 
-    public function __construct(EventRepository $eventRepository)
-    {
+    protected EventStatisticsCalculator $eventStatisticsCalculator;
+
+    protected RegistrationGuard $registrationGuard;
+
+    public function __construct(
+        EventRepository $eventRepository,
+        EventStatisticsCalculator $eventStatisticsCalculator,
+        RegistrationGuard $registrationGuard
+    ) {
         $this->eventRepository = $eventRepository;
+        $this->eventStatisticsCalculator = $eventStatisticsCalculator;
+        $this->registrationGuard = $registrationGuard;
     }
 
     /**
@@ -40,6 +51,10 @@ public function archiveAction(): ResponseInterface
     public function outlookAction(): ResponseInterface
     {
         $events = $this->eventRepository->findUpcoming();
+        foreach ($events as $event) {
+            $this->eventStatisticsCalculator->enrichWithStatistics($event);
+        }
+        $this->registrationGuard->setRegistrationPossibleByDateForEvents($events);
 
         $this->view->assign('events', $events);
 

diff --git a/Classes/Service/RegistrationGuard.php b/Classes/Service/RegistrationGuard.php
@@ -101,12 +101,14 @@ public function isRegistrationPossibleByDate(EventDateInterface $event): bool
     }
 
     /**
-     * @param array<EventDateInterface> $events
+     * @param array<Event> $events
      */
     public function setRegistrationPossibleByDateForEvents(array $events): void
     {
         foreach ($events as $event) {
-            $event->setRegistrationPossibleByDate($this->isRegistrationPossibleByDate($event));
+            if ($event instanceof EventDateInterface) {
+                $event->setRegistrationPossibleByDate($this->isRegistrationPossibleByDate($event));
+            }
         }
     }
 

diff --git a/Configuration/FlexForms/EventOutlook.xml b/Configuration/FlexForms/EventOutlook.xml
@@ -95,7 +95,7 @@
                                 <renderType>selectCheckBox</renderType>
                                 <minitems>1</minitems>
                                 <maxitems>99</maxitems>
-                                <default>date,topic,city</default>
+                                <default>date,topic,city,vacancies</default>
                                 <items type="array">
                                     <numIndex index="0" type="array">
                                         <numIndex index="0">
@@ -127,6 +127,12 @@
                                         </numIndex>
                                         <numIndex index="1">venue</numIndex>
                                     </numIndex>
+                                    <numIndex index="5" type="array">
+                                        <numIndex index="0">
+                                            LLL:EXT:seminars/Resources/Private/Language/locallang.xlf:plugin.eventOutlook.settings.displayOptions.columns.vacancies
+                                        </numIndex>
+                                        <numIndex index="1">vacancies</numIndex>
+                                    </numIndex>
                                 </items>
                             </config>
                         </TCEforms>

diff --git a/Configuration/TypoScript/PluginSettings.typoscript b/Configuration/TypoScript/PluginSettings.typoscript
@@ -9,4 +9,7 @@ plugin.tx_seminars.settings {
     decimals = {$plugin.tx_seminars.settings.currency.decimals}
     useDash = {$plugin.tx_seminars.settings.currency.useDash}
   }
+
+  # show "enough" instead of the exact number if there are at last this many vacancies
+  enoughVacanciesThreshold = {$plugin.tx_seminars.settings.enoughVacanciesThreshold}
 }
diff --git a/Configuration/TypoScript/constants.typoscript b/Configuration/TypoScript/constants.typoscript
@@ -21,5 +21,8 @@ plugin {
       # cat=plugin.tx_seminars.settings.currency//; type=boolean; label=Use the dash instead of decimal 00
       useDash = 0
     }
+
+    # cat=plugin.tx_seminars.settings//; type=int[1-999]; label=Show "enough" instead of the exact number if there are at last this many vacancies
+    enoughVacanciesThreshold = 5
   }
 }
diff --git a/Resources/Private/Language/locallang.xlf b/Resources/Private/Language/locallang.xlf
@@ -1686,6 +1686,9 @@ This event now has been confirmed.</source>
 			<trans-unit id="plugin.eventOutlook.settings.displayOptions.columns.venue">
 				<source>venue</source>
 			</trans-unit>
+			<trans-unit id="plugin.eventOutlook.settings.displayOptions.columns.vacancies">
+				<source>vacancies</source>
+			</trans-unit>
 			<trans-unit id="plugin.eventOutlook.message.noEventsFound">
 				<source>No events found.</source>
 			</trans-unit>
@@ -1704,6 +1707,15 @@ This event now has been confirmed.</source>
 			<trans-unit id="plugin.eventOutlook.events.property.venue">
 				<source>Venue</source>
 			</trans-unit>
+			<trans-unit id="plugin.eventOutlook.events.property.vacancies">
+				<source>Vacancies</source>
+			</trans-unit>
+			<trans-unit id="plugin.eventOutlook.events.property.vacancies.enough">
+				<source>enough</source>
+			</trans-unit>
+			<trans-unit id="plugin.eventOutlook.events.property.vacancies.fullyBooked">
+				<source>fully booked</source>
+			</trans-unit>
 			<trans-unit id="plugin.eventSingleView">
 				<source>Event single view</source>
 			</trans-unit>

diff --git a/Resources/Private/Partials/Event/OutlookList.html b/Resources/Private/Partials/Event/OutlookList.html
@@ -28,6 +28,11 @@
                         <f:translate key="plugin.eventOutlook.events.property.venue"/>
                     </th>
                 </oelib:isFieldEnabled>
+                <oelib:isFieldEnabled fieldName="vacancies">
+                    <th scope="col">
+                        <f:translate key="plugin.eventOutlook.events.property.vacancies"/>
+                    </th>
+                </oelib:isFieldEnabled>
             </tr>
         </thead>
         <tbody>
@@ -69,6 +74,11 @@
                             </f:for>
                         </td>
                     </oelib:isFieldEnabled>
+                    <oelib:isFieldEnabled fieldName="vacancies">
+                        <td class="text-end">
+                            <f:render partial="Event/Vacancies" arguments="{event: event}"/>
+                        </td>
+                    </oelib:isFieldEnabled>
                 </tr>
             </f:for>
         </tbody>

diff --git a/Resources/Private/Partials/Event/Vacancies.html b/Resources/Private/Partials/Event/Vacancies.html
@@ -0,0 +1,18 @@
+<html xmlns:f="http://typo3.org/ns/TYPO3/CMS/Fluid/ViewHelpers" data-namespace-typo3-fluid="true">
+    <f:variable name="statistics" value="{event.statistics}"/>
+    <f:if condition="({event.registrationRequired} && {event.registrationPossibleByDate})">
+        <f:if condition="({event.unlimitedSeats} || ({statistics.vacancies} >= {settings.enoughVacanciesThreshold}))">
+            <f:then>
+                <f:translate key="plugin.eventOutlook.events.property.vacancies.enough"/>
+                🟢
+            </f:then>
+            <f:else if="{statistics.fullyBooked}">
+                <f:translate key="plugin.eventOutlook.events.property.vacancies.fullyBooked"/>
+                🔴
+            </f:else>
+            <f:else>
+                {statistics.vacancies} 🟡
+            </f:else>
+        </f:if>
+    </f:if>
+</html>
diff --git a/Tests/Functional/Controller/EventControllerTest.php b/Tests/Functional/Controller/EventControllerTest.php
@@ -526,6 +526,153 @@ public function outlookActionRendersEventType(): void
         self::assertStringContainsString('workshop', $html);
     }
 
+    /**
+     * @test
+     */
+    public function outlookActionForEventWithUnlimitedSeatsRendersEnoughVacancies(): void
+    {
+        $this->importCSVDataSet(__DIR__ . '/Fixtures/EventController/outlookAction/EventOutlookContentElement.csv');
+        $this->importCSVDataSet(__DIR__ . '/Fixtures/EventController/outlookAction/FutureEventWithUnlimitedSeats.csv');
+
+        $request = (new InternalRequest())->withPageId(1);
+
+        $html = (string)$this->executeFrontendSubRequest($request)->getBody();
+
+        $enough = LocalizationUtility::translate('plugin.eventOutlook.events.property.vacancies.enough', 'seminars');
+        self::assertIsString($enough);
+        self::assertStringContainsString($enough, $html);
+        self::assertStringContainsString('🟢', $html);
+    }
+
+    /**
+     * @test
+     */
+    public function outlookActionForEventWithMoreThanEnoughVacanciesRendersEnoughVacancies(): void
+    {
+        $this->importCSVDataSet(__DIR__ . '/Fixtures/EventController/outlookAction/EventOutlookContentElement.csv');
+        $this->importCSVDataSet(
+            __DIR__ . '/Fixtures/EventController/outlookAction/FutureEventWithMoreThanEnoughVacancies.csv'
+        );
+
+        $request = (new InternalRequest())->withPageId(1);
+
+        $html = (string)$this->executeFrontendSubRequest($request)->getBody();
+
+        $enough = LocalizationUtility::translate('plugin.eventOutlook.events.property.vacancies.enough', 'seminars');
+        self::assertIsString($enough);
+        self::assertStringContainsString($enough, $html);
+        self::assertStringContainsString('🟢', $html);
+    }
+
+    /**
+     * @test
+     */
+    public function outlookActionForEventWithExactlyEnoughVacanciesRendersEnoughVacancies(): void
+    {
+        $this->importCSVDataSet(__DIR__ . '/Fixtures/EventController/outlookAction/EventOutlookContentElement.csv');
+        $this->importCSVDataSet(
+            __DIR__ . '/Fixtures/EventController/outlookAction/FutureEventWithExactlyEnoughVacancies.csv'
+        );
+
+        $request = (new InternalRequest())->withPageId(1);
+
+        $html = (string)$this->executeFrontendSubRequest($request)->getBody();
+
+        $enough = LocalizationUtility::translate('plugin.eventOutlook.events.property.vacancies.enough', 'seminars');
+        self::assertIsString($enough);
+        self::assertStringContainsString($enough, $html);
+        self::assertStringContainsString('🟢', $html);
+    }
+
+    /**
+     * @test
+     */
+    public function outlookActionForEventWithLessThanEnoughVacanciesRendersExactVacancies(): void
+    {
+        $this->importCSVDataSet(__DIR__ . '/Fixtures/EventController/outlookAction/EventOutlookContentElement.csv');
+        $this->importCSVDataSet(
+            __DIR__ . '/Fixtures/EventController/outlookAction/FutureEventWithLessThanEnoughVacancies.csv'
+        );
+
+        $request = (new InternalRequest())->withPageId(1);
+
+        $html = (string)$this->executeFrontendSubRequest($request)->getBody();
+
+        self::assertStringContainsString('4 🟡', $html);
+    }
+
+    /**
+     * @test
+     */
+    public function outlookActionForEventWithOneVacancyRendersExactVacancies(): void
+    {
+        $this->importCSVDataSet(__DIR__ . '/Fixtures/EventController/outlookAction/EventOutlookContentElement.csv');
+        $this->importCSVDataSet(__DIR__ . '/Fixtures/EventController/outlookAction/FutureEventWithOneVacancy.csv');
+
+        $request = (new InternalRequest())->withPageId(1);
+
+        $html = (string)$this->executeFrontendSubRequest($request)->getBody();
+
+        self::assertStringContainsString('1 🟡', $html);
+    }
+
+    /**
+     * @test
+     */
+    public function outlookActionForEventWithNoVacancyRendersFullyBooked(): void
+    {
+        $this->importCSVDataSet(__DIR__ . '/Fixtures/EventController/outlookAction/EventOutlookContentElement.csv');
+        $this->importCSVDataSet(__DIR__ . '/Fixtures/EventController/outlookAction/FutureEventWithNoVacancies.csv');
+
+        $request = (new InternalRequest())->withPageId(1);
+
+        $html = (string)$this->executeFrontendSubRequest($request)->getBody();
+
+        $fullyBooked = LocalizationUtility::translate(
+            'plugin.eventOutlook.events.property.vacancies.fullyBooked',
+            'seminars'
+        );
+        self::assertIsString($fullyBooked);
+        self::assertStringContainsString($fullyBooked, $html);
+        self::assertStringContainsString('🔴', $html);
+    }
+
+    /**
+     * @test
+     */
+    public function outlookActionForEventWithMoreThanEnoughVacanciesButDeadlineOverRendersNoVacancies(): void
+    {
+        $this->importCSVDataSet(__DIR__ . '/Fixtures/EventController/outlookAction/EventOutlookContentElement.csv');
+        $this->importCSVDataSet(
+            __DIR__ . '/Fixtures/EventController/outlookAction/FutureEventWithEnoughVacanciesButDeadlineOver.csv'
+        );
+
+        $request = (new InternalRequest())->withPageId(1);
+
+        $html = (string)$this->executeFrontendSubRequest($request)->getBody();
+
+        $enough = LocalizationUtility::translate('plugin.eventOutlook.events.property.vacancies.enough', 'seminars');
+        self::assertIsString($enough);
+        self::assertStringNotContainsString($enough, $html);
+    }
+
+    /**
+     * @test
+     */
+    public function outlookActionForEventWithoutRegistrationRendersNoVacancies(): void
+    {
+        $this->importCSVDataSet(__DIR__ . '/Fixtures/EventController/outlookAction/EventOutlookContentElement.csv');
+        $this->importCSVDataSet(__DIR__ . '/Fixtures/EventController/outlookAction/FutureEventWithoutRegistration.csv');
+
+        $request = (new InternalRequest())->withPageId(1);
+
+        $html = (string)$this->executeFrontendSubRequest($request)->getBody();
+
+        $enough = LocalizationUtility::translate('plugin.eventOutlook.events.property.vacancies.enough', 'seminars');
+        self::assertIsString($enough);
+        self::assertStringNotContainsString($enough, $html);
+    }
+
     /**
      * @test
      */

diff --git a/...nctional/Controller/Fixtures/EventController/outlookAction/EventOutlookContentElement.csv b/...nctional/Controller/Fixtures/EventController/outlookAction/EventOutlookContentElement.csv
@@ -19,7 +19,7 @@
                                                                  <sheet index=""displayOptions"">
                                                                      <language index=""lDEF"">
                                                                         <field index=""settings.fieldsToShow"">
-                                                                            <value index=""vDEF"">date,eventType,topic,city,venue</value>
+                                                                            <value index=""vDEF"">date,eventType,topic,city,venue,vacancies</value>
                                                                         </field>
                                                                     </language>
                                                                 </sheet>

diff --git a/.../Fixtures/EventController/outlookAction/FutureEventWithEnoughVacanciesButDeadlineOver.csv b/.../Fixtures/EventController/outlookAction/FutureEventWithEnoughVacanciesButDeadlineOver.csv
@@ -0,0 +1,3 @@
+"tx_seminars_seminars"
+,"uid","pid","title","begin_date","end_date","deadline_registration","needs_registration","attendees_max","offline_attendees",
+,1,2,"Extension Development with Extbase and Fluid",2524604400,2524604401,1,1,20,5
diff --git a/...ntroller/Fixtures/EventController/outlookAction/FutureEventWithExactlyEnoughVacancies.csv b/...ntroller/Fixtures/EventController/outlookAction/FutureEventWithExactlyEnoughVacancies.csv
@@ -0,0 +1,3 @@
+"tx_seminars_seminars"
+,"uid","pid","title","begin_date","end_date","needs_registration","attendees_max","offline_attendees"
+,1,2,"Extension Development with Extbase and Fluid",2524604400,2524604401,1,10,5
diff --git a/...troller/Fixtures/EventController/outlookAction/FutureEventWithLessThanEnoughVacancies.csv b/...troller/Fixtures/EventController/outlookAction/FutureEventWithLessThanEnoughVacancies.csv
@@ -0,0 +1,3 @@
+"tx_seminars_seminars"
+,"uid","pid","title","begin_date","end_date","needs_registration","attendees_max","offline_attendees"
+,1,2,"Extension Development with Extbase and Fluid",2524604400,2524604401,1,10,6
diff --git a/...troller/Fixtures/EventController/outlookAction/FutureEventWithMoreThanEnoughVacancies.csv b/...troller/Fixtures/EventController/outlookAction/FutureEventWithMoreThanEnoughVacancies.csv
@@ -0,0 +1,3 @@
+"tx_seminars_seminars"
+,"uid","pid","title","begin_date","end_date","needs_registration","attendees_max","offline_attendees",
+,1,2,"Extension Development with Extbase and Fluid",2524604400,2524604401,1,20,14
diff --git a/...nctional/Controller/Fixtures/EventController/outlookAction/FutureEventWithNoVacancies.csv b/...nctional/Controller/Fixtures/EventController/outlookAction/FutureEventWithNoVacancies.csv
@@ -0,0 +1,3 @@
+"tx_seminars_seminars"
+,"uid","pid","title","begin_date","end_date","needs_registration","attendees_max","offline_attendees"
+,1,2,"Extension Development with Extbase and Fluid",2524604400,2524604401,1,20,20
diff --git a/...unctional/Controller/Fixtures/EventController/outlookAction/FutureEventWithOneVacancy.csv b/...unctional/Controller/Fixtures/EventController/outlookAction/FutureEventWithOneVacancy.csv
@@ -0,0 +1,3 @@
+"tx_seminars_seminars"
+,"uid","pid","title","begin_date","end_date","needs_registration","attendees_max","offline_attendees"
+,1,2,"Extension Development with Extbase and Fluid",2524604400,2524604401,1,20,19
diff --git a/...ional/Controller/Fixtures/EventController/outlookAction/FutureEventWithUnlimitedSeats.csv b/...ional/Controller/Fixtures/EventController/outlookAction/FutureEventWithUnlimitedSeats.csv
@@ -0,0 +1,3 @@
+"tx_seminars_seminars"
+,"uid","pid","title","begin_date","end_date","needs_registration","attendees_max"
+,1,2,"Extension Development with Extbase and Fluid",2524604400,2524604401,1,0
diff --git a/...onal/Controller/Fixtures/EventController/outlookAction/FutureEventWithoutRegistration.csv b/...onal/Controller/Fixtures/EventController/outlookAction/FutureEventWithoutRegistration.csv
@@ -0,0 +1,3 @@
+"tx_seminars_seminars"
+,"uid","pid","title","begin_date","end_date","needs_registration","attendees_max"
+,1,2,"Extension Development with Extbase and Fluid",2524604400,2524604401,0,0
diff --git a/Tests/Unit/Controller/EventControllerTest.php b/Tests/Unit/Controller/EventControllerTest.php
@@ -6,6 +6,8 @@
 
 use OliverKlee\Seminars\Controller\EventController;
 use OliverKlee\Seminars\Domain\Repository\Event\EventRepository;
+use OliverKlee\Seminars\Service\EventStatisticsCalculator;
+use OliverKlee\Seminars\Service\RegistrationGuard;
 use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;
 use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
@@ -21,8 +23,14 @@ protected function setUp(): void
         parent::setUp();
 
         $eventRepositoryStub = $this->createStub(EventRepository::class);
-
-        $this->subject = new EventController($eventRepositoryStub);
+        $eventStatisticsCalculatorStub = $this->createStub(EventStatisticsCalculator::class);
+        $registrationGuardStub = $this->createStub(RegistrationGuard::class);
+
+        $this->subject = new EventController(
+            $eventRepositoryStub,
+            $eventStatisticsCalculatorStub,
+            $registrationGuardStub
+        );
     }
 
     /**