Fügen Sie die Standardkonfiguration in Ihr Drupal 8 Modul ein

Hauptthema: Standardkonfiguration

Überblick

In Drupal 7 erforderte die Standardkonfiguration für Module wie Inhaltstypen, Feldkonfigurationen, Ansichten usw. speziellen PHP-Code zur Installation und Aktualisierung. In Drupal 8 werden diese zusammen mit dem Konfigurationssystem in YAML-Textdateien gespeichert.

Beispielsweise kümmert sich das Konfigurationsmanagementsystem um die Erstellung und Verwaltung von Inhaltstypen. Sie können einen Inhaltstyp zusammen mit Ihrem Modul bereitstellen, indem Sie eine Konfigurationsdatei mit dem richtigen Namen und der richtigen Struktur erstellen.

Beispiel

Erstellen Sie eine Datei mit dem Namen node.type.example_mytype.yml und legen Sie sie im Verzeichnis Ihres Moduls im Unterordner config/install ab. Zum Beispiel könnte diese Datei in /modules/example/config/install/node.type.example_mytype.yml liegen, wenn sich das Modul in /modules/example befindet.

Bitte beachten Sie die Namenskonvention, bei der Sie das Präfix Ihres Inhaltstyps vor den Modulnamen setzen, gefolgt von einem Unterstrich, um Konflikte mit anderen Konfigurationsdateien zu vermeiden.

Dann können Sie den folgenden Code in diese Datei einfügen:

type: example_mytype
name: Example
description: 'Use <em>example</em> content to get to Drupal 8 development better.'
help: ''
new_revision: false
display_submitted: true
preview_mode: 1
status: true
langcode: en

Siehe node.type.article.yml für ein lebendes Beispiel.

Sie können Standardkonfigurationen für andere Dinge wie Blockplatzierungen, Ansichten, Textformate, Editor-Konfigurationen, Benutzerrollen usw. auf die gleiche Weise einbinden.

Sie können Standardwerte für Formularfelder wie den Autor eines Inhaltsknotens setzen.

Wenn Sie das Modul vor dem Hinzufügen dieses Inhaltstyps installiert haben, müssen Sie es deinstallieren und erneut installieren, damit die Konfiguration wirksam wird.

Export der Konfiguration

Sie können diese Dateien erzeugen, indem Sie die Konfiguration unter Konfiguration > Entwicklung > Konfigurationssynchronisierung exportieren. Sie können die Funktion "Einzelimport/-export" nutzen, um einen einzelnen Konfigurationsausschnitt zu exportieren; in diesem Fall erhalten Sie ein Textfeld mit dem Code zum Kopieren/Einfügen in die Konfigurationsdatei. Oder Sie können den "Vollständigen Export" ausführen, der Ihnen erlaubt, eine tar.gz-Datei herunterzuladen, die alle Konfigurationsdateien in einem Ordner enthält.

Beim Verwenden der exportierten Konfiguration ist es wichtig, die UUID aus der Konfiguration zu entfernen. Jeder Konfigurationsdatensatz wird eindeutig durch diese ID identifiziert. Wenn Sie diese UUID in Ihrem Modul belassen, wäre die ID für alle Sites, die Ihr Modul verwenden, identisch und damit nicht mehr eindeutig. Entfernen Sie einfach diese Zeile aus der Konfiguration, dann generiert Drupal beim Aktivieren Ihres Moduls neue UUIDs, um die Einzigartigkeit sicherzustellen.

uuid: 626187e6-2176-4a73-8900-c0912580e4a1 << Entfernen!
langcode: en
status: true

Drupal Console

Das Tool Drupal Console bietet folgenden Befehl:

• config:export:content:type

Dieser erledigt folgende Aufgaben:

• Exportiert alle Konfigurationsdateien, die mit dem angegebenen Inhaltstyp zusammenhängen (einschließlich der Feldkonfigurationsdateien).
• Platziert sie im Konfigurationsverzeichnis des entsprechenden Moduls.

Damit sparen Sie sich viel Arbeit, die sonst bei der manuellen Vorgehensweise anfällt.

Siehe auch

• YAML
• Drupal 8 Konfigurationssystem