You are here

Home » API reference » Configuration Synchronizer 8.2 » ConfigSyncImportForm.php

class ConfigSyncImportForm in Configuration Synchronizer 8.2

Hierarchy

Expanded class hierarchy of ConfigSyncImportForm

File

src/Form/ConfigSyncImportForm.php, line 12

Namespace

Drupal\config_sync\Form
View source 
class ConfigSyncImportForm extends ConfigDistroImportForm {

  /**
   * The configuration synchronizer lister.
   *
   * @var \Drupal\config_sync\configSyncListerInterface
   */
  protected $configSyncLister;

  /**
   * The configuration update lister.
   *
   * @var \Drupal\config_update\ConfigListInterface
   */
  protected $configUpdateLister;

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The theme handler.
   *
   * @var \Drupal\Core\Extension\ThemeHandlerInterface
   */
  protected $themeHandler;

  /**
   * The state storage object.
   *
   * @var \Drupal\Core\State\StateInterface
   */
  protected $state;

  /**
   * The filter manager.
   *
   * @var \Drupal\config_filter\ConfigFilterManagerInterface
   */
  protected $configFilterManager;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $class = parent::create($container);
    $class->configSyncLister = $container
      ->get('config_sync.lister');
    $class->configUpdateLister = $container
      ->get('config_update.config_list');
    $class->moduleHandler = $container
      ->get('module_handler');
    $class->themeHandler = $container
      ->get('theme_handler');
    $class->state = $container
      ->get('state');
    $class->configFilterManager = $container
      ->get('plugin.manager.config_filter');
    return $class;
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    // Ensure the filters reflect the current state of the file system.
    $this->configFilterManager
      ->clearCachedDefinitions();
    $form = parent::buildForm($form, $form_state);
    $form['config_sync'] = [
      '#type' => 'container',
    ];

    // Transform the UI to one based on our changelists.
    if ($changelists = $this->configSyncLister
      ->getExtensionChangelists()) {

      // Create a wrapper for the classic UI provided by core.
      $form['classic'] = [
        '#type' => 'details',
        '#title' => $this
          ->t('Classic version of configuration change listings'),
        '#weight' => 10,
      ];

      // For each collection, move the original listings coming from core's
      // form.
      foreach ($this
        ->getAllChangelistCollections($changelists) as $collection) {
        if (isset($form[$collection])) {
          $form['classic'][$collection] = $form[$collection];
          unset($form[$collection]);
        }
      }
      foreach ($changelists as $type => $extension_changelists) {
        $form['config_sync'][$type] = $this
          ->buildUpdatesListing($type, $extension_changelists);
      }
      if (!empty($form['actions']['submit'])) {
        $form['actions']['submit']['#value'] = $this
          ->t('Import');
      }
    }
    $update_mode = $this->state
      ->get('config_sync.update_mode', ConfigSyncListerInterface::DEFAULT_UPDATE_MODE);
    $form['config_sync']['advanced'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Advanced'),
      '#description' => $this
        ->t('Select the mode used to merge in updates. Choose "Merge" to merge updates into the site\'s active configuration while retaining any customizations made since the configuration was originally installed. "Merge" is the default and is recommended for most sites. Choose "Partial reset" if you wish available configuration updates to override any customizations you\'ve made to those items. Choose "Full reset" if you wish to discard all customizations made on your site and revert configuration to the state currently provided by installed modules, themes, and the install profile.'),
      '#open' => $update_mode !== ConfigSyncListerInterface::DEFAULT_UPDATE_MODE,
    ];
    $update_options = [
      ConfigSyncListerInterface::UPDATE_MODE_MERGE => $this
        ->t('Merge'),
      ConfigSyncListerInterface::UPDATE_MODE_PARTIAL_RESET => $this
        ->t('Partial reset'),
      ConfigSyncListerInterface::UPDATE_MODE_FULL_RESET => $this
        ->t('Full reset'),
    ];
    $form['config_sync']['advanced']['update_mode'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Update mode'),
      '#options' => $update_options,
      '#default_value' => $update_mode,
    ];
    $form['config_sync']['advanced']['submit'] = [
      '#type' => 'submit',
      '#value' => t('Change update mode'),
      '#submit' => [
        [
          $this,
          'updateModeChange',
        ],
      ],
    ];
    return $form;
  }

  /**
   * Form submission callback for changing the update mode.
   *
   * @param array $form
   *   The form render array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state.
   *
   * @return array
   *   The form render array.
   */
  public function updateModeChange(array &$form, FormStateInterface $form_state) {

    // Save the selected update_mode.
    $this->state
      ->set('config_sync.update_mode', (int) $form_state
      ->getValue('update_mode'));
  }

  /**
   * Returns a list of collections for a given set of changelists.
   *
   * @param array $changelists
   *   A set of changelists.
   *
   * @return array
   *   An array of collection names.
   */
  protected function getAllChangelistCollections(array $changelists) {
    $collections = [];
    foreach ($changelists as $extension_changelists) {
      foreach ($extension_changelists as $collection_changelists) {
        $collections = array_unique(array_merge($collections, array_keys($collection_changelists)));
      }
    }
    return $collections;
  }

  /**
   * Builds the portion of the form showing a listing of updates.
   *
   * @param string $type
   *   The type of extension (module or theme).
   * @param array $extension_changelists
   *   Associative array of configuration changes keyed by extension name.
   *
   * @return array
   *   A render array of a form element.
   */
  protected function buildUpdatesListing($type, array $extension_changelists) {
    $plugin_data = $this->state
      ->get('config_sync.plugins_previous', []);
    $type_labels = [
      'module' => $this
        ->t('Module'),
      'theme' => $this
        ->t('Theme'),
    ];
    $header = [
      'name' => [
        'data' => $this
          ->t('@type name', [
          '@type' => $type_labels[$type],
        ]),
      ],
      'details' => [
        'data' => $this
          ->t('Available configuration changes'),
        'class' => [
          RESPONSIVE_PRIORITY_LOW,
        ],
      ],
    ];
    $options = [];
    $default_value = [];
    foreach ($extension_changelists as $name => $collection_changelists) {
      $options[$name] = $this
        ->buildExtensionDetail($type, $name, $collection_changelists);

      // Status can be overridden in the state.
      $default_value[$name] = !isset($plugin_data[$type][$name]['status']) || $plugin_data[$type][$name]['status'] === TRUE;
    }
    $element = [
      '#type' => 'tableselect',
      '#header' => $header,
      '#options' => $options,
      '#multiple' => TRUE,
      '#attributes' => [
        'class' => [
          'config-sync-listing',
        ],
      ],
      '#default_value' => $default_value,
    ];
    return $element;
  }

  /**
   * Builds the details of a package.
   *
   * @param string $type
   *   The type of extension (module or theme).
   * @param string $name
   *   The machine name of the extension.
   * @param array $collection_changelists
   *   Associative array of configuration changes keyed by the type of change.
   * @param string $collection
   *   The configuration collection.
   *
   * @return array
   *   A render array of a form element.
   */
  protected function buildExtensionDetail($type, $name, $collection_changelists) {
    switch ($type) {
      case 'module':
        $label = $this->moduleHandler
          ->getName($name);
        break;
      case 'theme':
        $label = $this->themeHandler
          ->getName($name);
        break;
    }
    $element['name'] = [
      'data' => [
        '#type' => 'html_tag',
        '#tag' => 'h3',
        '#value' => $label,
      ],
      'class' => [
        'config-sync-extension-name',
      ],
    ];
    foreach ($collection_changelists as $collection => $changelist) {
      $extension_config = [];
      foreach ([
        'create',
        'update',
      ] as $change_type) {
        if (isset($changelist[$change_type])) {
          $extension_config[$change_type] = [];
          foreach ($changelist[$change_type] as $item_name => $item_label) {
            $config_type = $this->configUpdateLister
              ->getTypeNameByConfigName($item_name);
            if (!$config_type) {
              $config_type = 'system_simple';
            }
            if ($change_type == 'rename') {
              $names = $storage_comparer
                ->extractRenameNames($item_name);
              $route_options = array(
                'source_name' => $names['old_name'],
                'target_name' => $names['new_name'],
              );
            }
            else {
              $route_options = array(
                'source_name' => $item_name,
              );
            }
            if ($collection != StorageInterface::DEFAULT_COLLECTION) {
              $route_name = 'config_distro.diff_collection';
              $route_options['collection'] = $collection;
            }
            else {
              $route_name = 'config_distro.diff';
            }
            if (!isset($extension_config[$change_type][$config_type])) {
              $extension_config[$change_type][$config_type] = [];
            }
            $extension_config[$change_type][$config_type][$item_name] = [
              '#type' => 'link',
              '#title' => $item_label,
              '#url' => Url::fromRoute($route_name, $route_options),
              '#options' => [
                'attributes' => [
                  'class' => [
                    'use-ajax',
                  ],
                  'data-dialog-type' => 'modal',
                  'data-dialog-options' => json_encode([
                    'width' => 700,
                  ]),
                ],
              ],
            ];
          }
        }
      }
      $rows = [];
      if ($collection !== StorageInterface::DEFAULT_COLLECTION) {
        $rows[] = [
          [
            'data' => [
              '#type' => 'html_tag',
              '#tag' => 'h2',
              '#value' => $this
                ->t('@collection configuration collection', [
                '@collection' => $collection,
              ]),
              '#colspan' => 2,
            ],
          ],
        ];
      }
      $change_type_labels = [
        // Match the labels used by core.
        // @see ConfigSync::buildForm().
        'create' => $this
          ->t('New'),
        'update' => $this
          ->t('Changed'),
      ];

      // List config types for order.
      $config_types = $this->configSyncLister
        ->listConfigTypes();
      foreach ($extension_config as $change_type => $change_type_data) {
        $rows[] = [
          [
            'data' => [
              '#type' => 'html_tag',
              '#tag' => 'strong',
              '#value' => $change_type_labels[$change_type],
            ],
          ],
          [
            'data' => [
              '#type' => 'html_tag',
              '#tag' => 'strong',
              '#value' => $this
                ->t('View differences'),
            ],
          ],
        ];
        foreach ($config_types as $config_type => $config_type_label) {
          if (isset($change_type_data[$config_type])) {
            $row = [];
            $row[] = [
              'data' => [
                '#type' => 'html_tag',
                '#tag' => 'span',
                '#value' => $config_type_label,
                '#attributes' => [
                  'title' => $config_type,
                  'class' => [
                    'config-sync-item-type-label',
                  ],
                ],
              ],
            ];
            $row[] = [
              'data' => [
                '#theme' => 'item_list',
                '#items' => $change_type_data[$config_type],
                '#context' => [
                  'list_style' => 'comma-list',
                ],
              ],
              'class' => [
                'item',
              ],
            ];
            $rows[] = $row;
          }
        }
      }
    }
    $element['details'] = [
      'data' => [
        '#type' => 'table',
        '#rows' => $rows,
      ],
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Save the selected update_mode.
    $this->state
      ->set('config_sync.update_mode', (int) $form_state
      ->getValue('update_mode'));

    // Save data on selected modules and themes to the system state.
    $plugin_data = [];
    foreach ([
      'module',
      'theme',
    ] as $type) {
      if ($names = $form_state
        ->getValue($type)) {

        // Convert data to boolean values.
        array_walk($names, function ($value, $key) use ($type, &$plugin_data) {
          $value = (bool) $value;
          $plugin_data[$type][$key]['status'] = $value;
        });
      }
    }
    $this->state
      ->set('config_sync.plugins', $plugin_data);
    $this->state
      ->set('config_sync.plugins_previous', $plugin_data);
    $this->configFilterManager
      ->clearCachedDefinitions();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigDistroImportForm::finishBatch public static function Dispatches an event to notify modules about a successful import. Overrides ConfigSync::finishBatch
ConfigDistroImportForm::getFormId public function Returns a unique string identifying the form. Overrides ConfigSync::getFormId
ConfigSync::$activeStorage protected property The active configuration object.
ConfigSync::$configManager protected property The configuration manager.
ConfigSync::$eventDispatcher protected property Event dispatcher.
ConfigSync::$importTransformer protected property The import transformer service.
ConfigSync::$lock protected property The database lock object.
ConfigSync::$moduleExtensionList protected property The module extension list.
ConfigSync::$moduleInstaller protected property The module installer.
ConfigSync::$renderer protected property The renderer.
ConfigSync::$snapshotStorage protected property The snapshot configuration object.
ConfigSync::$syncStorage protected property The sync configuration object.
ConfigSync::$typedConfigManager protected property The typed config manager.
ConfigSync::processBatch Deprecated public static function Processes the config import batch and persists the importer.
ConfigSync::__construct public function Constructs the object.
ConfigSyncImportForm::$configFilterManager protected property The filter manager.
ConfigSyncImportForm::$configSyncLister protected property The configuration synchronizer lister.
ConfigSyncImportForm::$configUpdateLister protected property The configuration update lister.
ConfigSyncImportForm::$moduleHandler protected property The module handler. Overrides ConfigSync::$moduleHandler
ConfigSyncImportForm::$state protected property The state storage object.
ConfigSyncImportForm::$themeHandler protected property The theme handler. Overrides ConfigSync::$themeHandler
ConfigSyncImportForm::buildExtensionDetail protected function Builds the details of a package.
ConfigSyncImportForm::buildForm public function Form constructor. Overrides ConfigDistroImportForm::buildForm
ConfigSyncImportForm::buildUpdatesListing protected function Builds the portion of the form showing a listing of updates.
ConfigSyncImportForm::create public static function Instantiates a new instance of this class. Overrides ConfigDistroImportForm::create
ConfigSyncImportForm::getAllChangelistCollections protected function Returns a list of collections for a given set of changelists.
ConfigSyncImportForm::submitForm public function Form submission handler. Overrides ConfigSync::submitForm
ConfigSyncImportForm::updateModeChange public function Form submission callback for changing the update mode.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.