© saicle/Shutterstock.com
Content in einer Blockstruktur

CMS-Funktionen für Symfony-Applikationen


Applikationen im Netz, z. B. für einen Shop, brauchen CMS-Funktionen. Viele Anwendungen laufen sogar mit einem Contentmanagementsystem im Hintergrund, obwohl Content nicht im Fokus der Seite steht. Einfache Textblöcke, ganze Seiten – sobald wir anfangen, HTML zur Wiederverwendung zu speichern, sind wir schon nah dran. Sollen solche Seiten oder Blöcke editierbar sein, sind wir definitiv im Aufgabenbereich eines CMS.

Artikelserie

Teil 1: Content in einer Blockstruktur

Teil 2: Routen, Navigation und Seiten

Am Ende gehört aber noch mehr zu den Funktionen eines CMS. Welche davon unsere Anwendung wirklich braucht, hängt ganz vom Umfeld des Projekts ab. Schaut man sich die verschiedenen Fullstack-CMS auf dem Markt an, sind die Möglichkeiten, aber auch die Unterschiede inzwischen sehr groß. Man könnte sagen: „Da ist für jeden etwas dabei.“ Die Entscheidung für das richtige Fullstack-CMS ist schon nicht einfach. Aber müssen wir denn unbedingt ein ganzes CMS aufsetzen? Was wenn wir schon eine bestehende Applikation haben? Wenn es sich hierbei noch um eine Symfony-Applikation handelt, würde ich euch in diesem und im folgenden Artikel eine Lösung vorschlagen. Auch wenn wir am Beispiel einer Symfony-Applikation arbeiten werden, soll das Nutzer anderer Frameworks nicht vom Lesen abhalten. Denn es geht auch um Konzepte, wie ihr Content handhabt, ohne ein vollständiges CMS aufzusetzen.

Ein CMS aufsetzen oder die nötigen Funktionalitäten selbst bauen?

Wir werden in den Beispielen immer wieder dem sogenannten Document Manager begegnen. Analog zum Object Manager für das ORM von Doctrine haben wir hier einen Manager für die PHPCR-Version von Doctrine geschaffen. Da wir hier durchgehend mit Dokumenten hantieren, sprechen wir vom Document Manager. Bis auf einige zusätzliche Methoden für die Übersetzungen hat der Document Manager dasselbe Interface wie der Object Manager. Methoden wie persist(), find() oder flush() sollten geübten ORM-Nutzern bekannt vorkommen.

Bei PHPCR handelt es sich aber nicht um eine neue Datenbank. Vielmehr ist PHPCR ein Interface, um hierarchisch strukturierte Daten auf eine einheitliche Art und Weise zugänglich zu machen. Am Ende läuft PHPCR wie das ORM beim Anwender auf einem MySQL- oder ähnlichem System. Das heißt, für die Persistenz der folgenden Beispiele müssen wir keine zusätzliche Datenbank aufsetzen, wenn unsere Anwendung diese so oder so schon bereitstellt. Die Abhängigkeiten dafür sind dann mit Hilfe von Symfony Flex und einem passenden Rezept schon aufgesetzt.

Wenn es ums CMS und dessen Funktionalität geht, geht es in erster Linie um die Frage: Setzen wir ein ganzes CMS auf oder bauen wir uns die nötigen Funktionen selbst zusammen? Natürlich hat jedes der CMS, die wir auf dem Markt haben, einen Bereich, in dem es besonders gut wirkt. Doch wenn wir bereits eine Symfony-Applikation haben, lassen sich dessen Funktionen schlecht mit einem CMS kombinieren. Und meist ist es schwierig, nur einen Teil der Routen an das CMS zu geben und einen Teil in der ursprünglichen Anwendung zu belassen. Solche gemischten Szenarien treten auf, wenn wir nur bestimmte Funktionen eines CMS benötigen. Im ersten Teil soll gezeigt werden wie man vorgeht, wenn man „nur mal eben schnell“ Blöcke aus HTML persistieren möchte. Dabei sollten die Blöcke editierbar und wiederverwendbar sein. Spätestens wenn Entwickler eingesetzt werden müssen, um Texte in der Webapplikation zu ändern, sollte man anfangen, solchen Content in die Datenbank zu legen.

Am Anfang war der Block

Es fängt an mit Textblöcken, die man in schöner Symfony-Manier auch selbst in Form von sogenannten Partials in eigenen Templates ablegen kann. Das fördert die Wiederverwendbarkeit dieser Codeblöcke und macht den umliegenden Code damit deutlich lesbarer:

{# main.html.twig #}
{% extends 'base.html.twig' %}
 
{% {% block  content %}
  <div class="main">
    {% include 'included.html.twig' %}
  </div>
{% endblock %}}

Ein importiertes Twig-Template könnte dann so aussehen:

{# included.html.twig #}
 
<h2>Included</h2>
<p>Dieser Inhalt wird mehrfach verwendet.</p>

Häufig sprechen wir beim Inhalt von included.html.twig von einem Snippet oder einem Partial, aber im Grunde geht es hier um einen Teil des Contents, der wiederverwendbar sein soll. Wenn sich der Text in einem Block nicht wirklich ändern soll, so ist es sinnvoll, ihn zumindest für die i18n-Internationalisierung zugänglich zu machen. Das heißt, wir würden den Textinhalt im Symfony-eigenen Translation-System ablegen. Das ist zwar noch nicht wirklich dynamisch, doch schafft es die Möglichkeit, zentral an Inhalte zu gelangen.

Ein Block ist nicht genug

Nun wird es selten ausreichen, sich nur um einen Block zu kümmern. In der Realität sind es doch meist mehr. Für unser Beispiel, sagen wir mal, haben wir nur drei Blöcke. Diese sollen nun nacheinander ausgespielt und in einer Datenbank gespeichert werden. Wir geben jedem Block jeweils einen Namen: A, B, und C und persistieren den Inhalt wie hier angedeutet:

INSERT INTO blocks ('id', 'name', 'content') VALUES
  ('1', 'A', 'Inhalt von Block A'),
  ('2', 'B', 'Inhalt von Block B'),
  ('3', 'C', 'Inhalt von Block C');

Wir benutzen hier bewusst zusätzlich zur id ein Feld mit dem Namen name, damit wir nicht im Template oder im zugehörigen Controller direkt einen Primary Key einer Datenbanktabelle nutzen müssen. Um solch ein Set an Blöcken in einem Template zu nutzen, muss man den Inhalt irgendwoher beziehen. Mit Hilfe...

headline from sands settings