Entwicklung angepasster Module: Erstellen eines Modulgerüsts

Sie können Ihre Developer Portal -Site erweitern, indem Sie angepasste Module erstellen. Der Ausgangspunkt für ein neues Modul ist die Erstellung eines Modulgerüsts.

1. Wählen Sie einen Kurznamen, der auch als Maschinenname bezeichnet wird, für Ihr angepasstes Modul aus.
   Der Maschinenname wird in mehreren Dateien und Funktionen in Ihrem Modul sowie vom Drupal-Kern verwendet, um programmgestützt auf Ihr Modul zu verweisen. Der Name muss den folgenden Regeln entsprechen:

   • Er muss mit einem Buchstaben beginnen.
   • Er darf nur Kleinbuchstaben und Unterstreichungszeichen enthalten. (Beachten Sie, dass Drupal bei Verwendung von Großbuchstaben im Namen keine Hook-Implementierungen in Ihrem Modul erkennt.)
   • Er darf keine Leerzeichen enthalten.
   • Sie muss innerhalb Ihrer Developer Portal -Site eindeutig sein.
   • Es dürfen keine der folgenden reservierten Begriffe verwendet werden: src, lib, vendor, assets, css, files, images, js, misc, templates, includes, fixtures, Drupal.
2. Erstellen Sie einen Modulordner an einer Position Ihrer Wahl, z. B. /modules/module_name.
   Sie müssen den Ordner nicht wie Ihr Modulsystem benennen, aber Sie müssen daran denken, den Maschinennamen programmgestützt im Code und Dateinamen Ihres Moduls zu verwenden.
3. Erstellen Sie eine module_name.info.yml -Datei in Ihrem Modulordner.
   Dabei ist module_name der Kurzname oder Maschinenname, den Sie in Schritt 1ausgewählt haben.
4. Fügen Sie die Metadaten für Ihr angepasstes Modul wie folgt in die Datei module_name.info.yml ein:

   name: Example module name
   description: Description of the module.
   package: Custom
   
   type: module
   core: 8.x
   core_version_requirement: '^8 || ^9'
   version: 1.0
   
   dependencies:
     - module_name
   
   test_dependencies:
     - module_name
   
   configure: example.settings
   
   php: 7.1
   
   hidden: true

   wo

   • name (erforderlich) ist der Name Ihres Moduls und der Text, der auf der Modulverwaltungsseite in der Benutzerschnittstelle von Developer Portal angezeigt wird.
   • description (optional) ist eine Beschreibung Ihres Moduls und der Text, der auf der Modulverwaltungsseite in der Benutzerschnittstelle von Developer Portal angezeigt wird.
   • package (optional) ist ein Schlüssel, der es Ihnen ermöglicht, ähnliche Module zu gruppieren.
   • type (erforderlich) ist der Typ der Erweiterung, die Sie erstellen, z. B. ein Modul, ein Thema oder ein Profil. In dieser Instanz erstellen Sie ein Modul.
   • core (optional) gibt an, mit welcher Drupal -Kernversion Ihr Modul kompatibel ist.
   • core_version_requirement (erforderlich) gibt an, mit welchen Versionen von Drupal Ihr Modul kompatibel ist. In diesem Beispiel wird angegeben, dass das Modul mit allen Versionen von Drupal 8 und 9 kompatibel ist.
   • version (erforderlich) ist die Versionsnummer Ihres Moduls. Beachten Sie, dass version nicht erforderlich ist, wenn Sie Ihr Modul auf Drupal.org veröffentlichen.
   • dependencies (optional) ist eine YAML-Liste der Module, von denen Ihr Modul abhängig ist. Ihr Namensbereich muss im Format module_name angegeben werden, wobei module_name der Maschinenname des Moduls ist.
   • test_dependencies (optional) ist eine Liste aller Module (im selben Format wie dependencies), die für die Ausführung bestimmter automatisierter Tests für Ihr Modul im automatisierten Testausführungsprogramm von Drupal (DrupalCI) erforderlich sind, aber nicht allgemein als Modulabhängigkeiten benötigt werden.
   • configure (optional) - wenn Ihr Modul ein Konfigurationsformular anbietet, geben Sie hier die Route zu diesem Formular an.
   • php (optional) ist die PHP-Mindestversion, die für Ihr Modul erforderlich ist. Für das Developer Portal ist die PHP-Mindestversion 7.1.
   • hidden (optional) ist eine Option, mit der Ihr Modul im Abschnitt Erweitern des Administrator-Dashboards in der Benutzerschnittstelle des Developer Portal ausgeblendet wird. Diese Option ist möglicherweise nützlich, wenn Ihr Modul nur Tests enthält oder wenn das Modul als Beispiel für andere Entwickler vorgesehen ist.
5. Speichern Sie Ihre module_name.info.yml.

name: User field example
type: module
description: Developer Portal tutorial about a user field example
package: IBM API Connect Tutorials
core: 8.x
core_version_requirement: '^8 || ^9'
version: 8.x-0.0.1
dependencies:
  - ibm_apim
  - auth_apic