Ein Formular für Veranstaltungen ist schnell gebaut. Damit sich ein eigener Inhalt im Admin aber wie eine Seite verhält, muss er an viele Stellen von Sulu andocken: Rechte, Adresse, SEO, Vorschau, Sitemap, Papierkorb, Protokoll und Zeitsteuerung. Dieser Beitrag geht diese Stellen am Beispiel des SuluEventBundle durch. Zu jeder nenne ich das Interface oder den Service-Tag, über den Sulu die Erweiterung findet.

Den Rahmen bilden zwei Arbeitsphasen. Der erste Commit stammt vom 26. März 2021, Version 1.0.0 folgte einen Tag später, damals für Sulu 2.2. In den ersten drei Wochen kam fast alles dazu, was ein Inhaltstyp im Alltag braucht. Im September und Oktober 2023 folgten Papierkorb, Aktivitätsprotokoll und Zeitsteuerung. Die Codeschnipsel stammen, wenn nicht anders vermerkt, aus dem heutigen Branch 3.x für Sulu 3. Warum es das Bundle überhaupt gibt, steht im ersten Beitrag der Reihe: Wie das SuluEventBundle entstand.

Admin-Klasse und Rechte

Das Bundle hat von Anfang an zwei Inhaltstypen: Veranstaltungen und Veranstaltungsorte. Beide bekommen im Admin eine Liste, ein Formular und einen eigenen Sicherheitskontext. Sulu sammelt dafür alle Services mit dem Tag sulu.admin ein. Eine Admin-Klasse meldet Navigation, Ansichten und Sicherheitskontexte an. Damit entscheidet wie bei Seiten die Rolle, wer Events sehen, anlegen oder löschen darf. Für die Orte kam die Rechteprüfung am 27. März 2021 dazu.

Mehrsprachige Inhalte lagen unter Sulu 2 in eigenen Übersetzungstabellen. Das hatte eine Folge, die erst beim Bauen auffiel: Nach dem Titel ließ sich die Liste nicht mehr ohne Weiteres sortieren, weil der Titel in der Übersetzung stand. Die Sortierung nach übersetzten Eigenschaften habe ich am 29. März ergänzt.

Die Admin-Klasse für Events in services.yaml (gekürzt). yaml
sulu_event.admin.event:
    class: Manuxi\SuluEventBundle\Admin\EventAdmin
    tags:
        - { name: sulu.admin }
        - { name: sulu.context, context: admin }

Das Grundformular einer Veranstaltung in der Sulu-2-Fassung vom Herbst 2025. Titel, URL, Beginn und Ende, Ort, Bild und Text gibt es seit 2021.

Eine Adresse für jedes Event

Ein Event soll auf der Website eine eigene Adresse haben. Dafür nutzt das Bundle das Routing von Sulu. Seit dem 27. März 2021 gehört die Route zur Entität: Sie entsteht aus dem Titel, steht im Formular und lässt sich dort ändern oder neu erzeugen. Damit Sulu weiß, welcher Controller eine solche Adresse ausliefert, meldet ein Route-Defaults-Provider die Ressource events an (Tag sulu_route.route_defaults_provider).

SEO und Excerpt: erst kopiert, dann in Traits

Bei Seiten gehören der SEO-Tab und der Auszug (Excerpt) dazu. Ein eigener Inhaltstyp bekam sie unter Sulu 2 nicht geschenkt, ich musste beides selbst anbinden. Das Bundle speicherte die Angaben in eigenen Tabellen mit Übersetzungen, damit ein Event pro Sprache einen eigenen SEO-Titel und eine eigene Beschreibung haben kann.

Die erste SEO-Fassung steckte in zwei großen Klassen. Am 29. März 2021 habe ich sie in Interfaces und Traits zerlegt. Kürzer wurde der Code dadurch nicht, aber wiederverwendbar: Den Excerpt konnte ich am 30. und 31. März nach demselben Muster bauen, Autor und Autorendatum ebenso. Gleichzeitig wurde der Controller unübersichtlich, weil er Event, Übersetzung, SEO, Excerpt und Route speicherte. Am 30. März habe ich dafür Modellklassen eingeführt (EventModel, EventSeoModel, EventExcerptModel), am 31. März das LocationModel. Der Controller nimmt seitdem die Anfrage an, das Modell weiß, wie gespeichert wird.

Aus den Traits wurde später SuluSharedTools, ein gemeinsames Bundle für meine Bundles unter Sulu 2. Was so ein gemeinsames Bundle kosten kann, zeigte sich 2025 (Kalender, Wiederholungen und iCal). Unter Sulu 3 bringt Sulu SEO, Excerpt und Autor selbst als Traits mit, die eigenen Klassen sind entfallen (Der Umbau auf Sulu 3).

Das SEO-Interface vom 29. März 2021 (Branch 2.x, gekürzt). php
interface SeoTranslatableInterface
{
    public function getTitle(): ?string;
    public function setTitle(?string $title);
    public function getDescription(): ?string;
    public function setDescription(?string $description);
    public function getCanonicalUrl(): ?string;
    // … Keywords, Locale
}

Vorschau

Beim Bearbeiten sehen Redakteure neben dem Formular, wie das Event auf der Website aussehen wird. Sulu fragt dafür einen Preview-Object-Provider. Er lädt das Event in der gewählten Sprache und übernimmt die noch nicht gespeicherten Formulardaten, das Template rendert daraus die Seite. Angemeldet wird er mit dem Tag sulu_preview.object_provider und einem provider-key, der zum Resource-Key des Formulars passt. Beim EventBundle läuft die Vorschau seit dem 31. März 2021.

Der Preview-Object-Provider in services.yaml (gekürzt). yaml
sulu_event.preview_object_provider:
    class: Manuxi\SuluEventBundle\Preview\EventObjectProvider
    tags:
        - { name: sulu_preview.object_provider, provider-key: events }

Sitemap

Am 1. April 2021 kam der Sitemap-Provider dazu (Tag sulu.sitemap.provider). Die erste Fassung war einfach: Sie nahm alle aktiven Events auf. Die SEO-Option „In Sitemap verstecken“ stand zwar schon im Formular, ausgewertet hat der Provider sie erst später.

Heute nimmt er ein Event nur auf, wenn es veröffentlicht ist, zur Sprache der Domain gehört und im SEO-Tab nicht ausgeblendet wurde. Unter Sulu 3 steckt das in einer einzigen Join-Bedingung auf die DimensionContent-Einträge: Stand live, aktuelle Version, passende Sprache, nicht versteckt. Der Provider folgt damit denselben Entscheidungen der Redaktion wie der Rest der Website (Doku).

Die Bedingung im Sitemap-Provider unter Sulu 3 (EventSitemapProvider::findEvents()). php
$queryBuilder->leftJoin('event.dimensionContents', 'dimensionContent', 'WITH',
    'dimensionContent.locale = :locale
     AND dimensionContent.stage = :stage
     AND dimensionContent.version = :version
     AND (dimensionContent.seoHideInSitemap = :hide OR dimensionContent.seoHideInSitemap IS NULL)'
);

Papierkorb

Nach den ersten Wochen wurde es ruhiger. Im September 2023 nahm ich das Bundle wieder in die Hand, mit einem Ziel: Events sollten sich für Redakteure so verhalten wie Seiten. Am 24. September kam der Papierkorb. Gelöschte Events und Orte landen im Papierkorb von Sulu und lassen sich von dort wiederherstellen.

Dafür braucht jeder Inhaltstyp einen Handler, und eine Klasse trägt gleich drei Tags: sulu_trash.store_trash_item_handler für das Löschen, sulu_trash.restore_trash_item_handler für das Wiederherstellen und sulu_trash.restore_configuration_provider für den Dialog davor. Beim Löschen speichert store() alles, was zum Wiederaufbau nötig ist, unter Sulu 3 die DimensionContent-Einträge aller Sprachen. Beim Wiederherstellen baut restore() daraus das Event neu auf. Auch die Adresse muss dabei neu entstehen, sonst ist das Event zwar zurück, aber über seine URL nicht erreichbar. Für das Wiederherstellen folgte noch am selben Tag ein Bugfix.

Eine Klasse, drei Tags: der Papierkorb-Handler in services.yaml (gekürzt). yaml
sulu_event.trash_item_handler:
    class: Manuxi\SuluEventBundle\Trash\EventTrashItemHandler
    tags:
        - { name: sulu_trash.store_trash_item_handler }
        - { name: sulu_trash.restore_trash_item_handler }
        - { name: sulu_trash.restore_configuration_provider }

Aktivitäten

Sulu führt ein Protokoll darüber, wer wann welchen Inhalt angelegt, geändert oder gelöscht hat. Eigene Inhalte erscheinen dort nur, wenn sie ihre Vorgänge selbst melden. Das Bundle meldet Anlegen, Ändern, Veröffentlichen, Zurückziehen, Löschen, Wiederherstellen, das Kopieren in eine andere Sprache und die zeitgesteuerten Varianten von Veröffentlichen und Zurückziehen.

Jeder Vorgang ist eine kleine Klasse, die von Sulus DomainEvent erbt. Eine gemeinsame Basisklasse liefert Resource-Key, ID, Titel und Sicherheitskontext, die einzelne Klasse nur noch ihren Typ. Gemeldet wird über den DomainEventCollector, zum Beispiel nach dem Veröffentlichen mit collect(new PublishedEvent($event, [])). Im Admin erscheinen die Einträge im Tab Einblicke des Events.

Für Redakteure ist das ein Gewinn, den man erst bemerkt, wenn man ihn braucht: Wer wissen will, warum ein Event plötzlich offline ist oder wer es veröffentlicht hat, findet die Antwort im Protokoll.

Ein Vorgang für das Aktivitätsprotokoll und seine Meldung. php
class PublishedEvent extends AbstractEvent
{
    public function getEventType(): string
    {
        return 'published';
    }
}

$this->domainEventCollector->collect(new PublishedEvent($event, []));

Zeitsteuerung

Mit dem Automation Bundle von Sulu lassen sich Vorgänge zu einem festen Zeitpunkt auslösen. Das EventBundle bringt dafür zwei Handler mit, Veröffentlichen und Zurückziehen. Im Tab Automatisierung wählt man die Aufgabe und den Zeitpunkt. Ist er erreicht, ruft das Automation Bundle den Handler auf, dessen supports() für die Klasse Event zutrifft. Der Handler wendet den Workflow-Übergang an, speichert und meldet den Vorgang an das Protokoll.

Unter Sulu 3 fehlte die Zeitsteuerung zunächst. Am 28. September 2026 habe ich sie neu angebunden (Version 3.3.0). Die Handler werden nur geladen, wenn das Automation Bundle installiert ist, das EventBundle läuft auch ohne.

Der Handler für zeitgesteuertes Veröffentlichen (EventPublishTaskHandler, gekürzt). php
public function supports(string $entityClass): bool
{
    return Event::class === $entityClass;
}

public function handle($workload)
{
    $event = $this->eventRepository->findByUuid($workload['id']);
    // …
    $this->contentWorkflow->apply($event, ['locale' => $workload['locale']],
        WorkflowInterface::WORKFLOW_TRANSITION_PUBLISH);
    $this->entityManager->flush();
    $this->domainEventCollector->collect(new PublishedEvent($event, []));
}

Der Tab Automatisierung unter Sulu 3: Aufgabe „Veröffentlichen“ wählen, Zeitpunkt eintragen, speichern.

Vergangene und kommende Events: erst zwei Provider, dann einer

Auf einer Website will man oft nur bevorstehende Veranstaltungen zeigen und an anderer Stelle ein Archiv der beendeten. Meine erste Lösung vom 5. Oktober 2023 waren zwei zusätzliche Smart-Content-Provider, einer für abgelaufene und einer für ausstehende Events, jeweils mit eigener Repository-Klasse. Im Admin erschienen damit drei Inhaltsquellen für Events.

Drei Tage später, am 8. Oktober, habe ich beide wieder gestrichen. Smart Content kennt Typen: Ein Provider meldet in seiner Konfiguration eine Liste von Filtern an (enableTypes()), Redakteure wählen sie im Smart-Content-Feld aus, und die Auswahl kommt in $filters['types'] bei der Abfrage an. Seitdem gibt es einen Provider und eine Abfrage. Der Commit entfernte 109 Zeilen und fügte 47 hinzu.

Unter Sulu 3 trägt dieselbe Liste inzwischen auch die Event-Typen aus der Konfiguration, etwa Konferenz oder Workshop. Den Haken gab es von Anfang an, ich hatte nur nicht nachgesehen. Aus solchen Umwegen lerne ich am meisten: Bevor ich etwas Neues baue, lohnt der Blick in den Konfigurations-Builder der jeweiligen Stelle, ob Sulu die Option schon hat.

Ein Provider, zwei Filtertypen: EventDataProvider im Branch 2.x. php
protected function getTypes(): array
{
    return [
        ['type' => 'pending', 'title' => $this->translator->trans('sulu_event.filter.pending', [], 'admin')],
        ['type' => 'expired', 'title' => $this->translator->trans('sulu_event.filter.expired', [], 'admin')],
    ];
}

// in getConfiguration():
self::createConfigurationBuilder()
    ->enableTypes($this->getTypes())
    // …

Was sonst noch dazukam

  • Auswahlfelder für Seiten, mit denen Redakteure einzelne oder mehrere Events auswählen
  • ein Link-Provider, mit dem man im Texteditor auf ein Event verlinkt
  • eine Twig-Erweiterung, die Events auflöst und Listen liefert
  • ein Subscriber, der Autor und Autorendatum beim Speichern setzt (30. März 2021)
  • eine Funktion, die ein Event in andere Sprachen kopiert, mit Rechteprüfung für jede Zielsprache (14. April 2021)
  • Bild und URL pro Sprache (26. September 2023)

Unit-Tests gab es vom ersten Tag an, damals mit Travis. Seit dem 24. September 2023 laufen sie über GitHub Actions.

Danach

Zwischen den beiden Phasen kamen die ersten Beiträge von außen: YetiCGN hatte die Anpassung an Symfony 6 eingereicht, ich habe sie im Juni 2023 übernommen. 2024 blieb es bei Pflege, mit Symfony 6.4 und 7 und einem Pull Request von davidgorges, der die Abfragen PostgreSQL-tauglich machte. Im Herbst 2025 folgte der Kalender. Davon handelt der nächste Beitrag.

Repository: manuxi/SuluEventBundle auf GitHub