Erstellen eines Konfigurationsobjekttyps in Drupal 8

Auf dieser Seite wird ein Beispiel gezeigt, wie man in Drupal 8 einen Konfigurationsobjekttyp mit Verwaltungsseiten erstellt. Für ein Verständnis der Begriffe einfache Konfiguration und Konfigurationsobjekte siehe https://drupal.org/node/2120523.

Nach Aktivierung des Beispielmoduls, das den folgenden Code enthält, sollte das Beispiel-Konfigurationsformular unter „admin/config/system/example“ verfügbar sein, wie im Screenshot gezeigt:

Modul-Konfiguration und Administrator-Menüeintrag

example/example.info.yml

name: Example
description: 'Verwaltet Beispielkonfiguration.'
package: Example

type: module
core: 8.x

Routing

(Siehe einige Hilfsklassen für Entity-Pfade, um zu erfahren, wie man das vereinfacht.)

example/example.routing.yml

Die routing.yml-Datei definiert Routen für Verwaltungsseiten: Liste, Hinzufügen, Bearbeiten, Löschen.

entity.example.collection:
  path: '/admin/config/system/example'
  defaults:
    _entity_list: 'example'
    _title: 'Example configuration'
  requirements:
    _permission: 'administer site configuration'

entity.example.add_form:
  path: '/admin/config/system/example/add'
  defaults:
    _entity_form: 'example.add'
    _title: 'Add example'
  requirements:
    _permission: 'administer site configuration'

entity.example.edit_form:
  path: '/admin/config/system/example/{example}'
  defaults:
    _entity_form: 'example.edit'
    _title: 'Edit example'
  requirements:
    _permission: 'administer site configuration'

entity.example.delete_form:
  path: '/admin/config/system/example/{example}/delete'
  defaults:
    _entity_form: 'example.delete'
    _title: 'Delete example'
  requirements:
    _permission: 'administer site configuration'

example/example.links.menu.yml

Fügt einen Link zur Konfigurationsseite unter „System“ hinzu:

entity.example.collection:
  title: 'Example'
  parent: system.admin_config_system
  description: 'Beispiel konfigurieren'
  route_name: entity.example.collection

example/example.links.action.yml

Dadurch erscheint der Link „Hinzufügen“ auf der Listenseite.

entity.example.add_form:
  route_name: 'entity.example.add_form'
  title: 'Add example'
  appears_on:
    - entity.example.collection

Objekttyp-Klassen

example/src/ExampleInterface.php

Wenn Ihre Konfigurations-Entity Eigenschaften hat, müssen Sie entsprechende get/set-Methoden im Interface definieren.
 

namespace Drupal\example;

use Drupal\Core\Config\Entity\ConfigEntityInterface;

/**
 * Definiert ein Interface für die Example-Entity.
 */
interface ExampleInterface extends ConfigEntityInterface {
  // Fügen Sie hier get/set-Methoden für Ihre Konfigurationseigenschaften hinzu.
}

example/src/Entity/Example.php

Diese Datei definiert die Konfigurations-Entity-Klasse.
 

namespace Drupal\example\Entity;

use Drupal\Core\Config\Entity\ConfigEntityBase;
use Drupal\example\ExampleInterface;

/**
 * Definiert die Example-Entity.
 *
 * @ConfigEntityType(
 *   id = "example",
 *   label = @Translation("Example"),
 *   handlers = {
 *     "list_builder" = "Drupal\example\Controller\ExampleListBuilder",
 *     "form" = {
 *       "add" = "Drupal\example\Form\ExampleForm",
 *       "edit" = "Drupal\example\Form\ExampleForm",
 *       "delete" = "Drupal\example\Form\ExampleDeleteForm",
 *     }
 *   },
 *   config_prefix = "example",
 *   admin_permission = "administer site configuration",
 *   entity_keys = {
 *     "id" = "id",
 *     "label" = "label",
 *   },
 *   config_export = {
 *     "id",
 *     "label"
 *   },
 *   links = {
 *     "edit-form" = "/admin/config/system/example/{example}",
 *     "delete-form" = "/admin/config/system/example/{example}/delete",
 *   }
 * )
 */
class Example extends ConfigEntityBase implements ExampleInterface {

  /**
   * Die Example-ID.
   *
   * @var string
   */
  public $id;

  /**
   * Die Example-Beschriftung.
   *
   * @var string
   */
  public $label;

  // Ihre spezifischen get/set-Methoden für Konfigurationseigenschaften hier,
  // implementieren Sie das Interface.
}

Der Schlüssel admin_permission gewährt automatisch allen Benutzern mit dieser Berechtigung Zugriff. Wenn mehr Logik benötigt wird, kann ein benutzerdefinierter Access-Controller angegeben werden.

Ab Drupal 8.6.x wird empfohlen, dass alle Konfigurations-Entity-Typen eine Eigenschaft config_export in ihren Annotationen besitzen (siehe: https://www.drupal.org/node/2949023).

Konfigurationsschema-Datei

example/config/schema/example.schema.yml

example.example.*:
  type: config_entity
  label: 'Example config'
  mapping:
    id:
      type: string
      label: 'ID'
    label:
      type: label
      label: 'Label'

Fügen Sie in example.schema.yml die Eigenschaften/Attribute hinzu, die in \Drupal\example\Entity\Example definiert sind.

example.example.* ist die Konfigurationsvariable, die auf die Eigenschaften/Attribute unserer Klasse verweist. Sie können einen anderen Variablennamen für Ihre Entity angeben, indem Sie „config_prefix“ hinzufügen, z. B.:

@ConfigEntityType(
..
... config_prefix = "variable_name" ... 

Dann können Sie wie folgt darauf verweisen:

example.variable_name.*: ....

Weitere Informationen zum Konfigurationsschema finden Sie unter Konfigurationsschema/Metadaten.

Entity-Klassen

example/src/Form/ExampleForm.php

namespace Drupal\example\Form;

use Drupal\Core\Entity\EntityForm;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Messenger\MessengerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Formular-Handler für die Example-Erstellungs- und Bearbeitungsformulare.
 */
class ExampleForm extends EntityForm {

  /**
   * Konstruktor für das ExampleForm-Objekt.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   Der EntityTypeManager.
   */
  public function __construct(EntityTypeManagerInterface $entityTypeManager) {
    $this->entityTypeManager = $entityTypeManager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static(
      $container->get('entity_type.manager')
    );
  }

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $form = parent::form($form, $form_state);

    $example = $this->entity;

    $form['label'] = [
      '#type' => 'textfield',
      '#title' => $this->t('Bezeichnung'),
      '#maxlength' => 255,
      '#default_value' => $example->label(),
      '#description' => $this->t("Bezeichnung für das Beispiel."),
      '#required' => TRUE,
    ];
    $form['id'] = [
      '#type' => 'machine_name',
      '#default_value' => $example->id(),
      '#machine_name' => [
        'exists' => [$this, 'exist'],
      ],
      '#disabled' => !$example->isNew(),
    ];

    // Zusätzliche Formularelemente für Ihre benutzerdefinierten Eigenschaften.
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function save(array $form, FormStateInterface $form_state) {
    $example = $this->entity;
    $status = $example->save();

    if ($status === SAVED_NEW) {
      $this->messenger()->addMessage($this->t('Das Beispiel %label wurde erstellt.', [
        '%label' => $example->label(),
      ]));
    }
    else {
      $this->messenger()->addMessage($this->t('Das Beispiel %label wurde aktualisiert.', [
        '%label' => $example->label(),
      ]));
    }

    $form_state->setRedirect('entity.example.collection');
  }

  /**
   * Hilfsfunktion zur Prüfung, ob eine Example-Konfigurationsentity existiert.
   */
  public function exist($id) {
    $entity = $this->entityTypeManager->getStorage('example')->getQuery()
      ->condition('id', $id)
      ->execute();
    return (bool) $entity;
  }

}

example/src/Controller/ExampleListBuilder.php

namespace Drupal\example\Controller;

use Drupal\Core\Config\Entity\ConfigEntityListBuilder;
use Drupal\Core\Entity\EntityInterface;

/**
 * Bietet eine Auflistung der Example-Entities.
 */
class ExampleListBuilder extends ConfigEntityListBuilder {

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['label'] = $this->t('Example');
    $header['id'] = $this->t('Maschinenname');
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    $row['label'] = $entity->label();
    $row['id'] = $entity->id();

    // Hier können Sie weitere Eigenschaften hinzufügen...

    return $row + parent::buildRow($entity);
  }

}

example/src/Form/ExampleDeleteForm.php
 

namespace Drupal\example\Form;

use Drupal\Core\Entity\EntityConfirmFormBase;
use Drupal\Core\Url;
use Drupal\Core\Form\FormStateInterface;

/**
 * Baut das Formular zum Löschen einer Example-Entity.
 */
class ExampleDeleteForm extends EntityConfirmFormBase {

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this->t('Sind Sie sicher, dass Sie %name löschen möchten?', array('%name' => $this->entity->label()));
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return new Url('entity.example.collection');
  }

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {
    return $this->t('Löschen');
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->entity->delete();
    $this->messenger()->addMessage($this->t('Die Entity %label wurde gelöscht.', array('%label' => $this->entity->label())));

    $form_state->setRedirectUrl($this->getCancelUrl());
  }
}