Hier wird beschrieben, wie Sulu 3 aufgebaut ist: Symfony 7.4 mit Doctrine ORM statt PHPCR, je Sprache eine Entwurfs- und eine Live-Zeile für Seiten, Artikel und Schnipsel. Geändert wird über Messages mit EnableFlushStamp, nicht per SQL; Admin und Website laufen als zwei Kontexte mit eigenem Cache.
Reihe 5: Sulu für Entwickler Kapitel 1 von 16
Sulu 3 im Überblick
Kurz zusammengefasst
Administration und Website liegen als eine Symfony-Anwendung im selben Projekt. Die Angaben gelten für Sulu 3.0.11, die Version der Beispiel-Website bertrams-media.
Das Gerüst
Das Projekt läuft auf PHP ab Version 8.2 und Symfony 7.4. In der composer.lock der Beispiel-Website stehen sulu/sulu 3.0.11, symfony/framework-bundle 7.4.19 und doctrine/orm 3.7.2. Die Suche übernimmt die Bibliothek SEAL (cmsig/seal 0.12.16) im Paket search; das frühere MassiveSearchBundle gibt es nicht mehr.
Die Pakete
Der Kern liegt in vendor/sulu/sulu/packages: content, page, article, snippet, route, search und custom-url. Das Paket content ist die gemeinsame Grundlage. Seiten, Artikel und Schnipsel bauen darauf auf, route verwaltet ihre Adressen.
Jedes Paket hat vier Schichten: Domain, Application, Infrastructure und UserInterface. Welche Schicht welche andere nutzen darf, steht in der deptrac.yaml des Pakets. Medien, Kontakte, Benutzer, Kategorien und Tags liegen als klassische Bundles unter vendor/sulu/sulu/src/Sulu/Bundle.
Kein PHPCR mehr
Sulu 2 speicherte Inhalte in einem PHPCR-Repository, Sulu 3 nimmt dafür Doctrine-ORM-Entitäten; den Document Manager gibt es nicht mehr. Laut UPGRADE-3.x.md werden Inhalte über die Repositories der Pakete gelesen, zum Beispiel mit PageRepositoryInterface::getOneBy(['uuid' => $uuid]), während Anlegen, Ändern, Veröffentlichen und Löschen über Messages laufen.
Entwurf und Veröffentlicht
Eine Seite besteht aus mehreren Zeilen. Die Tabelle pa_pages hält die Seite selbst mit UUID und Stellung im Baum. Die Inhalte stehen in pa_page_dimension_contents, je Sprache und je Stand eine Zeile. Der Stand ist draft oder live (DimensionContentInterface::STAGE_DRAFT und STAGE_LIVE), der aktuelle Entwurf hat die Version 0 (CURRENT_VERSION). Bei Artikeln heißt die Tabelle ar_article_dimension_contents, die Spalte mit der UUID articleUuid.
Der Zustand einer Seite in jeder Sprache lässt sich so abfragen:
SELECT locale, stage, version, templateKey, workflowPlace
FROM pa_page_dimension_contents
WHERE pageUuid = 'UUID-der-Seite'
ORDER BY locale, stage, version;
Schreiben Sie nicht per SQL in diese Tabellen. Routen, Suchindex, Cache und Aktivitätenprotokoll ziehen nur nach, wenn die Änderung über Sulu läuft, also über Messages.
Inhalte per Message ändern
Jedes Paket bringt eigene Messages mit. Bei Artikeln sind das CreateArticleMessage, ModifyArticleMessage, RemoveArticleMessage, CopyArticleMessage und ApplyWorkflowTransitionArticleMessage. Seiten und Schnipsel haben entsprechende Messages mit Page beziehungsweise Snippet im Namen, Seiten zusätzlich MovePageMessage und OrderPageMessage.
Der Bus heißt sulu_message_bus; die Message geht in einem Envelope mit einem EnableFlushStamp hinein, denn nur dann schreibt die DoctrineFlushMiddleware aus dem Paket sulu/messenger die Änderung in die Datenbank.
<?php
use Sulu\Content\Domain\Model\WorkflowInterface;
use Sulu\Messenger\Infrastructure\Symfony\Messenger\FlushMiddleware\EnableFlushStamp;
use Sulu\Page\Application\Message\ApplyWorkflowTransitionPageMessage;
use Symfony\Component\Messenger\Envelope;
// $messageBus ist der Service "sulu_message_bus"
$messageBus->dispatch(new Envelope(
new ApplyWorkflowTransitionPageMessage(['uuid' => $uuid], $locale, WorkflowInterface::WORKFLOW_TRANSITION_PUBLISH),
[new EnableFlushStamp()],
));
Admin und Website
Ein Projekt läuft in zwei Kontexten. public/index.php startet SuluKernel::CONTEXT_ADMIN, wenn der Pfad mit /admin beginnt, sonst CONTEXT_WEBSITE. Auf der Konsole entscheidet das Skript: bin/adminconsole und bin/console laufen im Admin-Kontext, bin/websiteconsole im Website-Kontext. In der Beispiel-Website warnt bin/console zusätzlich beim Start, dass es im Admin-Kontext läuft.
Jeder Kontext hat sein eigenes Cache-Verzeichnis (SuluKernel::getCacheDir()). Darum stehen in den auto-scripts der composer.json beide Aufrufe: cache:clear und bin/websiteconsole cache:clear.
php bin/adminconsole cache:clear
php bin/websiteconsole cache:clear