Arbeiten mit Konfigurationsformularen

Verwendung von $config im Formular-Kontext

Sie können Konfigurationsformulare verwenden, um zu verstehen, wie $config die vom Benutzer eingegebenen Daten abrufen und die Daten in der Datei {module}.settings.yml ändern kann. Hier ist der Code zur Deklaration des $config-Objekts im Formular, den Sie in der PHP-Datei der Formulareinstellungen finden.

Die Klasse Drupal Core ConfigFactory ist der Weg, um Konfigurationsdaten zu lesen und zu schreiben. Sie wird verwendet, um eine Instanz des Config-Objekts basierend auf dem Inhalt der angegebenen Konfigurationsdatei zu erstellen. Das neue Config-Objekt kann dann verwendet werden, um CRUD-Operationen auf diesen Daten durchzuführen.

Beispiel für die Definition eines Formulars (befindet sich in example/src/Form/exampleSettingsForm.php):

namespace Drupal\example\Form;

use Drupal\Core\Form\ConfigFormBase;
use Drupal\Core\Form\FormStateInterface;

/**
 * Konfiguration der example Einstellungen für diese Seite.
 */
class ExampleSettingsForm extends ConfigFormBase {

  /** 
   * Konfigurationseinstellungen.
   *
   * @var string
   */
  const SETTINGS = 'example.settings';

  /** 
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'example_admin_settings';
  }

  /** 
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      static::SETTINGS,
    ];
  }

  /** 
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this->config(static::SETTINGS);

    $form['example_thing'] = [
      '#type' => 'textfield',
      '#title' => $this->t('Things'),
      '#default_value' => $config->get('example_thing'),
    ];  

    $form['other_things'] = [
      '#type' => 'textfield',
      '#title' => $this->t('Other things'),
      '#default_value' => $config->get('other_things'),
    ];  

    return parent::buildForm($form, $form_state);
  }

  /** 
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    // Konfiguration abrufen.
    $this->configFactory->getEditable(static::SETTINGS)
      // Die übermittelten Konfigurationseinstellungen setzen.
      ->set('example_thing', $form_state->getValue('example_thing'))
      // Sie können mehrere Konfigurationen gleichzeitig setzen, indem
      // Sie mehrere set()-Aufrufe machen.
      ->set('other_things', $form_state->getValue('other_things'))
      ->save();

    parent::submitForm($form, $form_state);
  }

}

Routing-Datei (example.routing.yml):

example.settings:
  path: '/admin/config/example/settings'
  defaults:
    _form: '\Drupal\example\Form\ExampleSettingsForm'
    _title: 'example'
  requirements:
    _permission: 'administer site configuration'

Mit dem Config-Objekt können Sie die aus dem Formular gesammelten Daten einfach verarbeiten. Mit dem obigen Code in der Formulareinstellungsdatei können Sie Formulardaten in {module}.settings.yml speichern.

Jede Klasse, die ConfigFormBase erweitert, muss die Methode getEditableConfigNames implementieren und ein Array von Konfigurationsfeldnamen zurückgeben, die sie bearbeitet.