Drupal 8 benutzerdefinierte Plugin -Typen

Drupal 8's robustes Plugin -System ermöglicht Backend -Entwickler mit wiederverwendbarer Funktionalität. In diesem Artikel (Teil 1) wird ein Funktion erstellt, in dem benutzerdefinierte Formulare mit Knotenentitäten erstellt werden, sodass die Konfiguration von Knotenbündeln neben Knotenanzeigen verschiedene Formulartypen verwendet. Neue Formulartypen lassen sich leicht durch Erweiterung einer bereitgestellten Basisklasse definieren. (Beispiel für ein vollständiges Code -Beispiel finden Sie in diesem Repository ).

Dieses Tutorial vermeidet eine ausführliche Plugin-Mechanik unter der Annahme der zugrunde liegenden Theorie. Wir erstellen unseren benutzerdefinierten Plugin -Typ mit zwei Schnittstellen und sechs Klassen - eine scheinbar große Anzahl, aber meist einfacher Kesselplattencode. Teil zwei wird demonstrieren, dass diese wiederverwendbaren Formen an Knoten angehoben werden.

Schlüsselkonzepte:

Das Plugin -System von Drupal 8 erleichtert wiederverwendbare Funktionen und aktiviert benutzerdefinierte Formulare für Knoteneinheiten. Knotenbündel können so konfiguriert werden, dass mehrere Formulartypen innerhalb der Knotenanzeigen verwendet werden.
Der Plugin -Manager, der für die Plugin -Erkennung und -Lade unerlässlich ist, nutzt die Standard -Basisklasse von Drupal für eine einfache Erweiterung. Alle Plugins müssen eine definierte Schnittstelle implementieren.
Plugin -Definitionen verwenden Anmerkungen mit wichtigen Informationen: das Plugin -Unterverzeichnis, die erforderliche Schnittstelle und die Annotationsklasse Definieren von Plugin -Eigenschaften.
Für ein benutzerdefiniertes Plugin -Typ ist eine Basisklasse für alle Plugins erweitert. Diese Klasse implementiert die Schnittstelle und verwendet Abhängigkeitsinjektion für den
• -Dienst, was für die Form des Formulars unerlässlich ist. Das Plugin interagiert mit Formklassen; Der nächste Schritt ist die Integration dieser Formulare mit Knotenanzeigen. form_builder

Plugin -Manager:

Der Plugin -Manager, der für das Entdecken und Laden von Plugins von entscheidender Bedeutung ist, erweitert Drupals

. In dem Verzeichnis des Moduls

enthält DefaultPluginManager: /src ReusableFormManager.php

Dies erweitert

<code class="language-php"><?php namespace Drupal\reusable_forms;

use Drupal\Core\Plugin\DefaultPluginManager;
use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Extension\ModuleHandlerInterface;

class ReusableFormsManager extends DefaultPluginManager {

  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
    parent::__construct('Plugin/ReusableForm', $namespaces, $module_handler, 'Drupal\reusable_forms\ReusableFormPluginInterface', 'Drupal\reusable_forms\Annotation\ReusableForm');
    $this->alterInfo('reusable_forms_info');
    $this->setCacheBackend($cache_backend, 'reusable_forms');
  }
}</code>

und überschreibt den Konstruktor. Schlüsselparameter definieren:

DefaultPluginManager

: Plugin -Unterverzeichnis.
• Plugin/ReusableForm
: Erforderliche Plugin -Schnittstelle.
• Drupalreusable_formsReusableFormPluginInterface
: Annotationsklasse definieren Plugin -Eigenschaften.
• Drupalreusable_formsAnnotationReusableForm
An einem Alter Hook (

) können Module Plugin -Definitionen ändern, und das Cache -Backend ist konfiguriert.

reusable_forms_info

Plugin -Schnittstelle:

Die Schnittstelle (

in

) definiert Methoden alle Plugins müssen implementiert: ReusableFormPluginInterface.php

<code class="language-php"><?php namespace Drupal\reusable_forms;

use Drupal\Core\Plugin\DefaultPluginManager;
use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Extension\ModuleHandlerInterface;

class ReusableFormsManager extends DefaultPluginManager {

  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
    parent::__construct('Plugin/ReusableForm', $namespaces, $module_handler, 'Drupal\reusable_forms\ReusableFormPluginInterface', 'Drupal\reusable_forms\Annotation\ReusableForm');
    $this->alterInfo('reusable_forms_info');
    $this->setCacheBackend($cache_backend, 'reusable_forms');
  }
}</code>

getName() Gibt den Plugin -Namen zurück. buildForm() akzeptiert ein Unternehmen und gibt ein Render -Array für ein Formular zur Implementierung Drupalreusable_formsFormReusableFormInterface zurück. Es erweitert PluginInspectionInterface und ContainerFactoryPluginInterface für zusätzliche Funktionalität und Abhängigkeitsinjektion.

Plugin -Annotation:

Die Annotationsklasse (ReusableForm.php in /src/Annotation) definiert Plugin -Eigenschaften:

<code class="language-php"><?php
namespace Drupal\reusable_forms;

use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Component\Plugin\PluginInspectionInterface;

interface ReusableFormPluginInterface extends PluginInspectionInterface, ContainerFactoryPluginInterface {

  public function getName();

  public function buildForm($entity);
}</code>

id, name und form (der Name der vollqualifizierten Formklasse) sind hier definiert.

Plugin -Basisklasse:

Die Plugin -Basisklasse (ReusableFormPluginBase.php in /src) enthält Standards:

<code class="language-php"><?php
namespace Drupal\reusable_forms\Annotation;

use Drupal\Component\Annotation\Plugin;

/**
 * @Annotation
 */
class ReusableForm extends Plugin {

  public $id;
  public $name;
  public $form;
}</code>

Dies erweitert PluginBase, implementiert ReusableFormPluginInterface und verwendet die Abhängigkeitsinjektion für form_builder. getName() und buildForm() werden unter Verwendung der in der Annotation angegebenen Formularklasse implementiert.

Formularschnitt und Basisklasse:

Eine einfache Formularschnittstelle (ReusableFormInterface.php in /src/Form) und die Basisklasse (ReusableFormBase.php in /src/Form) werden für die Konsistenz erstellt: (Diese werden in der ursprünglichen Antwort angezeigt und werden hier nicht für die Kürze wiederholt) .

Schlussfolgerung (Teil 1):

In diesem ersten Teil wird der benutzerdefinierte Plugin -Typ eingerichtet und für die Integration mit Formularklassen vorbereitet. In Teil zwei werden diese Formulare mit Knoten angezeigt, die die Konfiguration des Knotentyps und das Formring in den Inhaltsansichtsmodi beinhalten.

Das obige ist der detaillierte Inhalt vonDrupal 8 benutzerdefinierte Plugin -Typen. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!