Reihe 5: Sulu für Entwickler Kapitel 8 von 16

Inhalte per Code schreiben

Entwicklung
Gilt für: jede Sulu-Website Stand: Sulu 3.0

Kurz zusammengefasst

Hier wird beschrieben, wie Inhalte per Code geändert werden: mit Messages und EnableFlushStamp, bei Teil-Updates immer mit template und mit vorher gelesenen Feldern wie seo. Veröffentlicht wird nur, was vorher veröffentlicht war; bei mehreren Sprachen wird der Entity Manager vor jeder Änderung geleert und danach nach doppelten Zeilen gesucht.

Inhalte per Code zu ändern heißt, dasselbe zu tun wie der Admin: eine Message schicken, die Sulu verarbeitet. Drei Fallen sind dabei in der Website bertrams-media sichtbar geworden: ein fehlendes Template, ein zu eifriges Veröffentlichen und der Zustand des Entity Managers bei mehreren Sprachen.

Vorher hilfreich: 5.1 Sulu 3 im Überblick

Das Muster

Die Klassen und Befehle in diesem Kapitel stammen aus der Beispiel-Website, sie sind kein Sulu-Standard. Die Klasse App\Content\TemplateFieldWriter setzt ein Feld einer Seite oder eines Artikels, so wie es der Admin tut. Sie zeigt alle Regeln dieses Kapitels in 20 Zeilen. Die Message geht an den Bus sulu_message_bus, jeweils mit EnableFlushStamp (siehe „Sulu 3 im Überblick“):

Aus src/Content/TemplateFieldWriter.php, gekürzt php
// Wie eine Admin-Anfrage pro Änderung: den Entity Manager leeren
$this->entityManager->clear();

$identifier = ['uuid' => $uuid];
// Sulu mappt das Template bei jeder Änderung; Artikel haben keinen Standard
$data = ['template' => $template, $field => $value, 'locale' => $locale];

$this->dispatch('page' === $type
    ? new ModifyPageMessage($identifier, $data)
    : new ModifyArticleMessage($identifier, $data));

if (self::PUBLISHED === $result) {
    $this->dispatch('page' === $type
        ? new ApplyWorkflowTransitionPageMessage($identifier, $locale, WorkflowInterface::WORKFLOW_TRANSITION_PUBLISH)
        : new ApplyWorkflowTransitionArticleMessage($identifier, $locale, WorkflowInterface::WORKFLOW_TRANSITION_PUBLISH));
}

Teil-Updates: template mitschicken

Eine Message mit nur locale und einem Feld genügt nicht. Der TemplateDataMapper ruft getDefaultType() auf, bevor er die Felder prüft. Artikel haben keinen Standardtyp, es kommt ein TypeError. Schicken Sie deshalb immer template mit, den aktuellen templateKey der Entwurfszeile, wie es auch der Admin tut. Folge: Die obersten Schlüssel von templateData werden neu sortiert, der Inhalt bleibt gleich.

Felder wie seo ersetzt Sulu als Ganzes. Das aktuelle seoData muss deshalb vorher gelesen und die eigene Änderung hineingeführt werden; das macht App\Seo\SeoWriter mit SeoChange::mergeInto().

Nur veröffentlichen, was veröffentlicht war

Ein Entwurf kann offene Änderungen tragen, die niemand freigegeben hat. Wird nach jeder Änderung einfach veröffentlicht, gehen diese mit live. Die Writer der Beispiel-Website entscheiden deshalb am workflowPlace der Entwurfszeile:

Aus src/Content/TemplateFieldWriter.php php
public static function result(?string $workflowPlace, bool $publish): string
{
    return match (true) {
        WorkflowInterface::WORKFLOW_PLACE_PUBLISHED === $workflowPlace && $publish => self::PUBLISHED,
        \in_array($workflowPlace, [WorkflowInterface::WORKFLOW_PLACE_DRAFT, WorkflowInterface::WORKFLOW_PLACE_REVIEW_DRAFT], true) => self::DRAFT_PENDING,
        default => self::DRAFT,
    };
}

Nur bei published wird veröffentlicht; bei draft oder review_draft bleibt der Inhalt Entwurf, und der Befehl meldet das.

Mehrere Sprachen: EntityManager leeren

Nach der Änderung der deutschen Fassung liegt der Artikel im Identity Map von Doctrine, mit einer Collection, die nur die deutsche und die strukturellen Zeilen enthält. Wird im selben Prozess die englische Fassung geändert, findet Sulu dort keine englische Zeile. Die DimensionContentCollectionFactory legt eine neue, leere Entwurfszeile an (version = 0, unpublished), und das anschließende Veröffentlichen bricht ab. Der Admin hat das Problem nicht, weil jede Änderung eine eigene Anfrage ist; im eigenen Code lässt sich diese Trennung mit EntityManager::clear() vor jeder Änderung nachbauen.

Das gilt für jede Schleife über Sprachen oder Inhalte, die Messages schickt. SeoWriter und TemplateFieldWriter leeren den Entity Manager vor jeder Änderung.

Doppelte Dimension-Zeilen finden

Manchmal liegen für denselben Artikel, Stand, Sprache und dieselbe Version zwei Zeilen mit verschiedenem Inhalt in ar_article_dimension_contents. Die Website und die Vorschau ziehen dann nicht immer dieselbe. Das Symptom: Der Admin zeigt den neuen Stand, die Website den alten. Entdeckt wurde das in der Beispiel-Website nach mehreren Runden Bearbeitung über MCP und durch den Fehler mit den Sprachen oben. Diese Abfrage findet die Gruppen:

Doppelte Zeilen je Artikel, Stand, Sprache und Version sql
SELECT articleUuid, stage, locale, version, COUNT(*) AS anzahl
FROM ar_article_dimension_contents
WHERE locale IS NOT NULL
GROUP BY articleUuid, stage, locale, version
HAVING COUNT(*) > 1;

Zwei Hinweise dazu:

  • WHERE locale IS NOT NULL ist wichtig. Jeder Artikel hat zusätzlich Zeilen ohne Sprache für die Felder, die nicht übersetzt werden. Das ist kein Fehler, diese Zeilen bleiben unberührt.
  • Löschen Sie die zweite Zeile nicht. Daran hängen Kategorien und Schlagwörter in eigenen Tabellen. Die Beispiel-Website gleicht stattdessen templateData und title aller Zeilen der Gruppe an die Zeile mit dem jüngsten changed an. Danach bleiben die Zeilen doppelt, sind aber gleich.

Nach dem Angleichen leeren Sie den Cache der Website: php bin/websiteconsole cache:clear.

Als Befehl, nicht als Skript

Einmalige Datenarbeit schreibt die Beispiel-Website als app:-Befehl mit einem Service in src/, mit --dry-run und einem Test. Beispiele: app:seo:apply, app:content:set-field, app:content:publish und app:content:delete. Gelöscht wird nur mit --force, ohne zeigt der Befehl, was er tun würde. Die Metadaten der Templates gibt es nur im Admin-Kontext, solche Befehle laufen mit bin/adminconsole.

Mehr dazu

Offizielle Dokumentation