07 - Display the registrations for each event in the admin interface

Author: wachterjohannes

config/lists/event_registrations.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0" ?>
+<list xmlns="http://schemas.sulu.io/list-builder/list">
+    <key>event_registrations</key>
+
+    <properties>
+        <property name="id" visibility="no" translation="sulu_admin.id">
+            <field-name>id</field-name>
+            <entity-name>App\Entity\EventRegistration</entity-name>
+        </property>
+
+        <property name="firstName" visibility="always" searchability="yes" translation="sulu_contact.first_name">
+            <field-name>firstName</field-name>
+            <entity-name>App\Entity\EventRegistration</entity-name>
+        </property>
+
+        <property name="lastName" visibility="always" searchability="yes" translation="sulu_contact.last_name">
+            <field-name>lastName</field-name>
+            <entity-name>App\Entity\EventRegistration</entity-name>
+        </property>
+
+        <property name="email" visibility="always" searchability="yes" translation="sulu_contact.email">
+            <field-name>email</field-name>
+            <entity-name>App\Entity\EventRegistration</entity-name>
+        </property>
+
+        <identity-property name="eventId" visibility="never">
+            <field-name>event</field-name>
+            <entity-name>App\Entity\EventRegistration</entity-name>
+        </identity-property>
+    </properties>
+</list>

config/packages/sulu_admin.yaml

@@ -14,6 +14,10 @@ sulu_admin:
                 list: app.get_events
                 detail: app.get_event
 
+        event_registrations:
+            routes:
+                list: app.get_event_registrations
+
     # Registering Selection Field Types in this section
     field_type_options:
         selection:

config/routes_admin.yaml

@@ -4,3 +4,9 @@ app.event_api:
     resource: App\Controller\Admin\EventController
     prefix: /admin/api
     name_prefix: app.
+
+app.event_registration_api:
+    type: rest
+    resource: App\Controller\Admin\EventRegistrationController
+    prefix: /admin/api
+    name_prefix: app.

src/Admin/EventAdmin.php

@@ -5,6 +5,7 @@
 namespace App\Admin;
 
 use App\Entity\Event;
+use App\Entity\EventRegistration;
 use Sulu\Bundle\AdminBundle\Admin\Admin;
 use Sulu\Bundle\AdminBundle\Admin\Navigation\NavigationItem;
 use Sulu\Bundle\AdminBundle\Admin\Navigation\NavigationItemCollection;
@@ -22,6 +23,8 @@ class EventAdmin extends Admin
 
     const EVENT_LIST_VIEW = 'app.events_list';
 
+    const EVENT_REGISTRATION_LIST_KEY = 'event_registrations';
+
     const EVENT_ADD_FORM_VIEW = 'app.event_add_form';
 
     const EVENT_EDIT_FORM_VIEW = 'app.event_edit_form';
@@ -119,5 +122,16 @@ public function configureViews(ViewCollection $viewCollection): void
             ->addToolbarActions($formToolbarActions)
             ->setParent(static::EVENT_EDIT_FORM_VIEW);
         $viewCollection->add($editDetailsFormView);
+
+        $editDetailsFormView = $this->viewBuilderFactory->createListViewBuilder(static::EVENT_EDIT_FORM_VIEW . '.registrations', '/registrations')
+            ->setResourceKey(EventRegistration::RESOURCE_KEY)
+            ->setListKey(self::EVENT_REGISTRATION_LIST_KEY)
+            ->setTabTitle('app.registrations')
+            ->addRouterAttributesToListRequest(['id' => 'eventId'])
+            ->addListAdapters(['table'])
+            ->addToolbarActions([])
+            ->setUserSettingsKey(EventRegistration::RESOURCE_KEY)
+            ->setParent(static::EVENT_EDIT_FORM_VIEW);
+        $viewCollection->add($editDetailsFormView);
     }
 }

src/Controller/Admin/EventRegistrationController.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Controller\Admin;
+
+use App\Common\DoctrineListRepresentationFactory;
+use App\Entity\EventRegistration;
+use FOS\RestBundle\Controller\Annotations\RouteResource;
+use FOS\RestBundle\Routing\ClassResourceInterface;
+use FOS\RestBundle\View\ViewHandlerInterface;
+use Sulu\Component\Rest\AbstractRestController;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
+
+/**
+ * @RouteResource("event_registration")
+ */
+class EventRegistrationController extends AbstractRestController implements ClassResourceInterface
+{
+    /**
+     * @var DoctrineListRepresentationFactory
+     */
+    private $doctrineListRepresentationFactory;
+
+    public function __construct(
+        DoctrineListRepresentationFactory $doctrineListRepresentationFactory,
+        ViewHandlerInterface $viewHandler,
+        ?TokenStorageInterface $tokenStorage = null
+    ) {
+        $this->doctrineListRepresentationFactory = $doctrineListRepresentationFactory;
+
+        parent::__construct($viewHandler, $tokenStorage);
+    }
+
+    public function cgetAction(int $eventId): Response
+    {
+        $listRepresentation = $this->doctrineListRepresentationFactory->createDoctrineListRepresentation(
+            EventRegistration::RESOURCE_KEY,
+            ['eventId' => $eventId]
+        );
+
+        return $this->handleView($this->view($listRepresentation));
+    }
+}

src/Entity/EventRegistration.php

@@ -12,6 +12,8 @@
  */
 class EventRegistration
 {
+    const RESOURCE_KEY = 'event_registrations';
+
     /**
      * @var int|null
      *

tests/Functional/Controller/Admin/EventRegistrationControllerTest.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Tests\Functional\Controller\Admin;
+
+use App\Tests\Functional\Traits\EventRegistrationTrait;
+use App\Tests\Functional\Traits\EventTrait;
+use Sulu\Bundle\TestBundle\Testing\SuluTestCase;
+use Symfony\Bundle\FrameworkBundle\KernelBrowser;
+use Symfony\Component\HttpFoundation\Response;
+
+class EventRegistrationControllerTest extends SuluTestCase
+{
+    use EventRegistrationTrait;
+    use EventTrait;
+
+    /**
+     * @var KernelBrowser
+     */
+    private $client;
+
+    protected function setUp(): void
+    {
+        $this->client = $this->createAuthenticatedClient();
+        $this->purgeDatabase();
+    }
+
+    public function testCGet(): void
+    {
+        $event1 = $this->createEvent('Sulu is awesome', 'de');
+        $event2 = $this->createEvent('Symfony live is awesome', 'de');
+
+        $registration1 = $this->createEventRegistration($event1, 'Max', 'Mustermann');
+        $registration2 = $this->createEventRegistration($event2, 'Mira', 'Musterfrau');
+
+        $this->client->request('GET', '/admin/api/events/' . $event1->getId() . '/registrations');
+
+        $response = $this->client->getResponse();
+        $this->assertInstanceOf(Response::class, $response);
+        $result = json_decode($response->getContent() ?: '', true);
+        $this->assertHttpStatusCode(200, $response);
+
+        $this->assertSame(1, $result['total']);
+        $this->assertCount(1, $result['_embedded']['event_registrations']);
+        $items = $result['_embedded']['event_registrations'];
+
+        $this->assertSame($registration1->getId(), $items[0]['id']);
+
+        $this->assertSame($registration1->getFirstName(), $items[0]['firstName']);
+        $this->assertSame($registration1->getLastName(), $items[0]['lastName']);
+        $this->assertArrayHasKey('email', $items[0]);
+    }
+}

tests/Functional/Traits/EventRegistrationTrait.php

@@ -11,6 +11,20 @@
 
 trait EventRegistrationTrait
 {
+    public function createEventRegistration(Event $event, string $firstName, string $lastName): EventRegistration
+    {
+        $event = $this->getEventRegistrationRepository()->create($event);
+        $event->setFirstName($firstName);
+        $event->setLastName($lastName);
+        $event->setEmail($firstName . '@' . $lastName . '.at');
+        $event->setMessage('');
+
+        static::getEntityManager()->persist($event);
+        static::getEntityManager()->flush();
+
+        return $event;
+    }
+
     /**
      * @return EventRegistration[]
      */

translations/admin.de.json

@@ -1,6 +1,7 @@
 {
     "app.events": "Veranstaltungen",
     "app.image": "Bild",
+    "app.registrations": "Registrierungen",
     "app.teaser": "Kurzbeschreibung",
     "app.start_date": "Start",
     "app.end_date": "Ende",

translations/admin.en.json

@@ -1,6 +1,7 @@
 {
     "app.events": "Events",
     "app.image": "Image",
+    "app.registrations": "Registrations",
     "app.teaser": "Teaser",
     "app.start_date": "Start",
     "app.end_date": "Ende",