ConfigSingleExportForm.php

<?php

namespace Drupal\config\Form;

use Drupal\Core\Config\Entity\ConfigEntityInterface;
use Drupal\Core\Config\StorageInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Form\FormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Htmx\Htmx;
use Drupal\Core\Serialization\Yaml;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\Core\Url;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Provides a form for exporting a single configuration file.
 *
 * @internal
 */
class ConfigSingleExportForm extends FormBase {
  
  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;
  
  /**
   * The config storage.
   *
   * @var \Drupal\Core\Config\StorageInterface
   */
  protected $configStorage;
  
  /**
   * Tracks the valid config entity type definitions.
   *
   * @var \Drupal\Core\Entity\EntityTypeInterface[]
   */
  protected $definitions = [];
  
  /**
   * Constructs a new ConfigSingleImportForm.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Config\StorageInterface $config_storage
   *   The config storage.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, StorageInterface $config_storage) {
    $this->entityTypeManager = $entity_type_manager;
    $this->configStorage = $config_storage;
  }
  
  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container->get('entity_type.manager'), $container->get('config.storage'));
  }
  
  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'config_single_export_form';
  }
  
  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, string $config_type = '', string $config_name = '') {
    foreach ($this->entityTypeManager
      ->getDefinitions() as $entity_type => $definition) {
      if ($definition->entityClassImplements(ConfigEntityInterface::class)) {
        $this->definitions[$entity_type] = $definition;
      }
    }
    $entity_types = array_map(function (EntityTypeInterface $definition) {
      return $definition->getLabel();
    }, $this->definitions);
    // Sort the entity types by label, then add the simple config to the top.
    uasort($entity_types, 'strnatcasecmp');
    $config_types = [
      'system.simple' => $this->t('Simple configuration'),
    ] + $entity_types;
    $form['config_type'] = [
      '#title' => $this->t('Configuration type'),
      '#type' => 'select',
      '#options' => $config_types,
      '#default_value' => $config_type,
    ];
    // The config_name element depends on the value of config_type.
    // Select and replace the wrapper element of the <select> tag
    $form_url = Url::fromRoute('config.export_single', [
      'config_type' => $config_type,
      'config_name' => $config_name,
    ]);
    (new Htmx())->post($form_url)
      ->select('*:has(>select[name="config_name"])')
      ->target('*:has(>select[name="config_name"])')
      ->swap('outerHTML')
      ->applyTo($form['config_type']);
    $default_type = $form_state->getValue('config_type', $config_type);
    $form['config_name'] = [
      '#title' => $this->t('Configuration name'),
      '#type' => 'select',
      '#options' => $this->findConfiguration($default_type),
      '#empty_option' => $this->t('- Select -'),
      '#default_value' => $config_name,
    ];
    // The export element depends on the value of config_type and config_name.
    // Select and replace the wrapper element of the export textarea.
    (new Htmx())->post($form_url)
      ->select('[data-export-wrapper]')
      ->target('[data-export-wrapper]')
      ->swap('outerHTML')
      ->applyTo($form['config_name']);
    $form['export'] = [
      '#title' => $this->t('Here is your configuration:'),
      '#type' => 'textarea',
      '#rows' => 24,
      '#wrapper_attributes' => [
        'data-export-wrapper' => TRUE,
      ],
    ];
    $pushUrl = FALSE;
    $trigger = $this->getHtmxTriggerName();
    if ($trigger == 'config_type') {
      $form = $this->updateConfigurationType($form, $form_state);
      // Also update the empty export element "out of band".
      (new Htmx())->swapOob('outerHTML:[data-export-wrapper]')
        ->applyTo($form['export'], '#wrapper_attributes');
      $pushUrl = Url::fromRoute('config.export_single', [
        'config_type' => $default_type,
        'config_name' => '',
      ]);
    }
    elseif ($trigger == 'config_name') {
      // A name is selected.
      $default_name = $form_state->getValue('config_name', $config_name);
      $form['export'] = $this->updateExport($form, $default_type, $default_name);
      // Update the url in the browser location bar.
      $pushUrl = Url::fromRoute('config.export_single', [
        'config_type' => $default_type,
        'config_name' => $default_name,
      ]);
    }
    elseif ($config_type && $config_name) {
      // We started with values, update the export using those.
      $form['export'] = $this->updateExport($form, $config_type, $config_name);
    }
    if ($pushUrl) {
      (new Htmx())->pushUrlHeader($pushUrl)
        ->applyTo($form);
    }
    return $form;
  }
  
  /**
   * Handles switching the configuration type selector.
   */
  public function updateConfigurationType($form, FormStateInterface $form_state) {
    $form['config_name']['#options'] = $this->findConfiguration($form_state->getValue('config_type'));
    $form['export']['#value'] = NULL;
    return $form;
  }
  
  /**
   * Handles switching the export textarea.
   */
  public function updateExport($form, string $config_type, string $config_name) {
    // Determine the full config name for the selected config entity.
    // Calling this in the main form build requires accounting for not yet
    // having input.
    if (!empty($config_type) && $config_type !== 'system.simple') {
      $definition = $this->entityTypeManager
        ->getDefinition($config_type);
      $name = $definition->getConfigPrefix() . '.' . $config_name;
    }
    else {
      $name = $config_name;
    }
    // Read the raw data for this config name, encode it, and display it.
    $exists = $this->configStorage
      ->exists($name);
    $form['export']['#value'] = !$exists ? NULL : Yaml::encode($this->configStorage
      ->read($name));
    $form['export']['#description'] = !$exists ? NULL : $this->t('Filename: %name', [
      '%name' => $name . '.yml',
    ]);
    return $form['export'];
  }
  
  /**
   * Handles switching the configuration type selector.
   */
  protected function findConfiguration($config_type) {
    $names = [];
    // For a given entity type, load all entities.
    if ($config_type && $config_type !== 'system.simple') {
      $entity_storage = $this->entityTypeManager
        ->getStorage($config_type);
      foreach ($entity_storage->loadMultiple() as $entity) {
        $entity_id = $entity->id();
        if ($label = $entity->label()) {
          $names[$entity_id] = new TranslatableMarkup('@id (@label)', [
            '@label' => $label,
            '@id' => $entity_id,
          ]);
        }
        else {
          $names[$entity_id] = $entity_id;
        }
      }
    }
    else {
      // Gather the config entity prefixes.
      $config_prefixes = array_map(function (EntityTypeInterface $definition) {
        return $definition->getConfigPrefix() . '.';
      }, $this->definitions);
      // Find all config, and then filter our anything matching a config prefix.
      $names += $this->configStorage
        ->listAll();
      $names = array_combine($names, $names);
      foreach ($names as $config_name) {
        foreach ($config_prefixes as $config_prefix) {
          if (str_starts_with($config_name, $config_prefix)) {
            unset($names[$config_name]);
          }
        }
      }
    }
    return $names;
  }
  
  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    // Nothing to submit.
  }

}