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

Ein Projekt aufsetzen und der Webspace

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

Kurz zusammengefasst

Hier wird beschrieben, wie ein Sulu-3-Projekt entsteht: Das Skeleton kommt mit composer create-project sulu/skeleton, die Datenbank baut sulu:build. Templates sucht Sulu in config/templates/{pages,articles,snippets,blocks}, und die Webspace-Datei in config/webspaces/ legt Sprachen, Standard-Templates, Menüs und Adressen je Umgebung fest.

Das Skeleton stammt von den Sulu-Entwicklern. Das Beispiel für die Webspace-Datei ist die Datei der Website bertrams-media, die Domains sind durch example ersetzt.

Vorher hilfreich: 5.1 Sulu 3 im Überblick

Installieren

Die Anleitung „Getting Started“ der offiziellen Dokumentation nennt drei Befehle, die das Projekt anlegen, die Datenbank aufbauen und einen PHP-Server starten. Vorher gehört die Verbindung zur Datenbank als DATABASE_URL in die Datei .env.local; unterstützt sind MySQL, MariaDB und PostgreSQL, SQLite nicht.

Installation nach der offiziellen Anleitung bash
composer create-project sulu/skeleton my-project -n

# DATABASE_URL in .env.local setzen, dann:
php bin/adminconsole sulu:build dev
php -S localhost:8000 -t public/ config/router.php

Wo Sulu die Templates sucht

Sulu liest XML-Templates aus festen Verzeichnissen im Projekt:

  • config/templates/pages für Seiten
  • config/templates/articles für Artikel
  • config/templates/snippets für Schnipsel
  • config/templates/blocks für globale Blöcke

Die Twig-Dateien dazu liegen unter templates/; der Pfad steht im Template im Element <view>. Weitere Verzeichnisse lassen sich unter sulu_admin.templates.<typ>.directories eintragen, so wie es die Beispiel-Website in config/packages/sulu_admin.yaml für die Testimonials tut. Wie die Templates aufgebaut sind, steht in den Kapiteln „Seiten-Templates“ und „Blöcke, Includes und Atome“.

Die Webspace-Datei

Ein Webspace ist eine Website im Projekt, seine Datei liegt in config/webspaces/. Die Beispiel-Website hat zwei: bertrams-media.de.xml für die Hauptwebsite und infinity.xml für eine Bühnenseite. Hier ist die Hauptdatei, gekürzt:

config/webspaces/example.xml, gekürzt aus der Datei der Beispiel-Website html
<?xml version="1.0" encoding="utf-8"?>
<webspace xmlns="http://schemas.sulu.io/webspace/webspace"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://schemas.sulu.io/webspace/webspace http://schemas.sulu.io/webspace/webspace-1.1.xsd">
    <name>example</name>
    <key>example</key>

    <localizations>
        <localization language="de" default="true"/>
        <localization language="en"/>
    </localizations>

    <default-templates>
        <default-template type="home">default</default-template>
        <default-template type="page">default</default-template>
    </default-templates>

    <templates>
        <template type="search">pages/search</template>
        <template type="error">error/error</template>
        <template type="error-404">error/error</template>
    </templates>

    <navigation>
        <contexts>
            <context key="main">
                <meta>
                    <title lang="en">Main Navigation</title>
                    <title lang="de">Hauptnavigation</title>
                </meta>
            </context>
        </contexts>
    </navigation>

    <portals>
        <portal>
            <name>example</name>
            <key>example</key>
            <environments>
                <environment type="prod">
                    <urls>
                        <url language="de">www.example.de</url>
                        <url language="en">www.example.com</url>
                    </urls>
                </environment>
                <environment type="dev">
                    <urls>
                        <url language="de">local.example.de</url>
                        <url language="en">local.example.com</url>
                    </urls>
                </environment>
            </environments>
        </portal>
    </portals>
</webspace>
  • key muss unter allen Webspaces eindeutig sein. Routen und Schnipsel-Bereiche hängen daran, deshalb später nicht mehr ändern.
  • localizations nennt die Sprachen, eine ist default. Die Beispiel-Website hat de, en und nl.
  • default-templates legt fest, welches Template eine neue Startseite (home) und eine neue Seite (page) bekommt. Die Startseite der Beispiel-Website nutzt onepage.
  • templates weist Sonderseiten zu: Suche, Fehlerseite und die 404-Seite.
  • navigation/contexts sind die Menüs, in die der Admin Seiten einhängen lässt. Die Beispiel-Website hat main, footer, footer-bottom und links.
  • environments ordnen jeder Umgebung und Sprache eine Adresse zu. Der Typ (prod, stage, test, dev) wird mit kernel.environment verglichen, also mit APP_ENV.

Mehrere Webspaces

Die Hauptwebsite und die Bühnenseite laufen im selben Projekt. Damit die Bühne nicht alle Seiten-Templates anbietet, schließt ihre Datei mit <excluded-templates> onepage und sidebar aus. Das Element blendet Templates im Auswahlfeld des Seitenformulars aus.

Artikel gehören zu einem Haupt-Webspace. Die Beispiel-Website trägt ihn in config/packages/sulu_article.yaml ein: sulu_article.default_main_webspace: bertrams-media. Schnipsel sind dagegen nicht an einen Webspace gebunden.

Einen weiteren Webspace anlegen

Das Cookbook „Adding new Webspace“ der offiziellen Dokumentation beschreibt die Schritte. Danach leeren Sie beide Caches (siehe „Sulu 3 im Überblick“) und prüfen, ob die Domain im Webserver auf dasselbe public/ zeigt.

Mehr dazu

Offizielle Dokumentation