You are here

Home » API reference » Drupal 8 » ConfigSync.php

class ConfigSync in Drupal 8

Same name and namespace in other branches
  1. 9 core/modules/config/src/Form/ConfigSync.php \Drupal\config\Form\ConfigSync
  2. 10 core/modules/config/src/Form/ConfigSync.php \Drupal\config\Form\ConfigSync

Construct the storage changes in a configuration synchronization form.

@internal

Hierarchy

Expanded class hierarchy of ConfigSync

1 string reference to 'ConfigSync'
config.routing.yml in core/modules/config/config.routing.yml
core/modules/config/config.routing.yml

File

core/modules/config/src/Form/ConfigSync.php, line 30

Namespace

Drupal\config\Form
View source 
class ConfigSync extends FormBase {

  /**
   * The database lock object.
   *
   * @var \Drupal\Core\Lock\LockBackendInterface
   */
  protected $lock;

  /**
   * The sync configuration object.
   *
   * @var \Drupal\Core\Config\StorageInterface
   */
  protected $syncStorage;

  /**
   * The active configuration object.
   *
   * @var \Drupal\Core\Config\StorageInterface
   */
  protected $activeStorage;

  /**
   * The snapshot configuration object.
   *
   * @var \Drupal\Core\Config\StorageInterface
   */
  protected $snapshotStorage;

  /**
   * Event dispatcher.
   *
   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
   */
  protected $eventDispatcher;

  /**
   * The configuration manager.
   *
   * @var \Drupal\Core\Config\ConfigManagerInterface
   */
  protected $configManager;

  /**
   * The typed config manager.
   *
   * @var \Drupal\Core\Config\TypedConfigManagerInterface
   */
  protected $typedConfigManager;

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

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

  /**
   * The module installer.
   *
   * @var \Drupal\Core\Extension\ModuleInstallerInterface
   */
  protected $moduleInstaller;

  /**
   * The renderer.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * The module extension list.
   *
   * @var \Drupal\Core\Extension\ModuleExtensionList
   */
  protected $moduleExtensionList;

  /**
   * The import transformer service.
   *
   * @var \Drupal\Core\Config\ImportStorageTransformer
   */
  protected $importTransformer;

  /**
   * Constructs the object.
   *
   * @param \Drupal\Core\Config\StorageInterface $sync_storage
   *   The source storage.
   * @param \Drupal\Core\Config\StorageInterface $active_storage
   *   The target storage.
   * @param \Drupal\Core\Config\StorageInterface $snapshot_storage
   *   The snapshot storage.
   * @param \Drupal\Core\Lock\LockBackendInterface $lock
   *   The lock object.
   * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $event_dispatcher
   *   Event dispatcher.
   * @param \Drupal\Core\Config\ConfigManagerInterface $config_manager
   *   Configuration manager.
   * @param \Drupal\Core\Config\TypedConfigManagerInterface $typed_config
   *   The typed configuration manager.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\Core\Extension\ModuleInstallerInterface $module_installer
   *   The module installer.
   * @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
   *   The theme handler.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer.
   * @param \Drupal\Core\Extension\ModuleExtensionList $extension_list_module
   *   The module extension list
   * @param \Drupal\Core\Config\ImportStorageTransformer $import_transformer
   *   The import transformer service.
   */
  public function __construct(StorageInterface $sync_storage, StorageInterface $active_storage, StorageInterface $snapshot_storage, LockBackendInterface $lock, EventDispatcherInterface $event_dispatcher, ConfigManagerInterface $config_manager, TypedConfigManagerInterface $typed_config, ModuleHandlerInterface $module_handler, ModuleInstallerInterface $module_installer, ThemeHandlerInterface $theme_handler, RendererInterface $renderer, ModuleExtensionList $extension_list_module, ImportStorageTransformer $import_transformer = NULL) {
    $this->syncStorage = $sync_storage;
    $this->activeStorage = $active_storage;
    $this->snapshotStorage = $snapshot_storage;
    $this->lock = $lock;
    $this->eventDispatcher = $event_dispatcher;
    $this->configManager = $config_manager;
    $this->typedConfigManager = $typed_config;
    $this->moduleHandler = $module_handler;
    $this->moduleInstaller = $module_installer;
    $this->themeHandler = $theme_handler;
    $this->renderer = $renderer;
    $this->moduleExtensionList = $extension_list_module;
    if (is_null($import_transformer)) {
      @trigger_error('The config.import_transformer service must be passed to ConfigSync::__construct(), it is required before Drupal 9.0.0. See https://www.drupal.org/node/3066005.', E_USER_DEPRECATED);
      $import_transformer = \Drupal::service('config.import_transformer');
    }
    $this->importTransformer = $import_transformer;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.storage.sync'), $container
      ->get('config.storage'), $container
      ->get('config.storage.snapshot'), $container
      ->get('lock.persistent'), $container
      ->get('event_dispatcher'), $container
      ->get('config.manager'), $container
      ->get('config.typed'), $container
      ->get('module_handler'), $container
      ->get('module_installer'), $container
      ->get('theme_handler'), $container
      ->get('renderer'), $container
      ->get('extension.list.module'), $container
      ->get('config.import_transformer'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Import all'),
    ];
    $syncStorage = $this->importTransformer
      ->transform($this->syncStorage);
    $source_list = $syncStorage
      ->listAll();
    $storage_comparer = new StorageComparer($syncStorage, $this->activeStorage);
    if (empty($source_list) || !$storage_comparer
      ->createChangelist()
      ->hasChanges()) {
      $form['no_changes'] = [
        '#type' => 'table',
        '#header' => [
          $this
            ->t('Name'),
          $this
            ->t('Operations'),
        ],
        '#rows' => [],
        '#empty' => $this
          ->t('There are no configuration changes to import.'),
      ];
      $form['actions']['#access'] = FALSE;
      return $form;
    }
    elseif (!$storage_comparer
      ->validateSiteUuid()) {
      $this
        ->messenger()
        ->addError($this
        ->t('The staged configuration cannot be imported, because it originates from a different site than this site. You can only synchronize configuration between cloned instances of this site.'));
      $form['actions']['#access'] = FALSE;
      return $form;
    }

    // A list of changes will be displayed, so check if the user should be
    // warned of potential losses to configuration.
    if ($this->snapshotStorage
      ->exists('core.extension')) {
      $snapshot_comparer = new StorageComparer($this->activeStorage, $this->snapshotStorage);
      if (!$form_state
        ->getUserInput() && $snapshot_comparer
        ->createChangelist()
        ->hasChanges()) {
        $change_list = [];
        foreach ($snapshot_comparer
          ->getAllCollectionNames() as $collection) {
          foreach ($snapshot_comparer
            ->getChangelist(NULL, $collection) as $config_names) {
            if (empty($config_names)) {
              continue;
            }
            foreach ($config_names as $config_name) {
              $change_list[] = $config_name;
            }
          }
        }
        sort($change_list);
        $message = [
          [
            '#markup' => $this
              ->t('The following items in your active configuration have changes since the last import that may be lost on the next import.'),
          ],
          [
            '#theme' => 'item_list',
            '#items' => $change_list,
          ],
        ];
        $this
          ->messenger()
          ->addWarning($this->renderer
          ->renderPlain($message));
      }
    }

    // Store the comparer for use in the submit.
    $form_state
      ->set('storage_comparer', $storage_comparer);

    // Add the AJAX library to the form for dialog support.
    $form['#attached']['library'][] = 'core/drupal.dialog.ajax';
    foreach ($storage_comparer
      ->getAllCollectionNames() as $collection) {
      if ($collection != StorageInterface::DEFAULT_COLLECTION) {
        $form[$collection]['collection_heading'] = [
          '#type' => 'html_tag',
          '#tag' => 'h2',
          '#value' => $this
            ->t('@collection configuration collection', [
            '@collection' => $collection,
          ]),
        ];
      }
      foreach ($storage_comparer
        ->getChangelist(NULL, $collection) as $config_change_type => $config_names) {
        if (empty($config_names)) {
          continue;
        }

        // @todo A table caption would be more appropriate, but does not have the
        //   visual importance of a heading.
        $form[$collection][$config_change_type]['heading'] = [
          '#type' => 'html_tag',
          '#tag' => 'h3',
        ];
        switch ($config_change_type) {
          case 'create':
            $form[$collection][$config_change_type]['heading']['#value'] = $this
              ->formatPlural(count($config_names), '@count new', '@count new');
            break;
          case 'update':
            $form[$collection][$config_change_type]['heading']['#value'] = $this
              ->formatPlural(count($config_names), '@count changed', '@count changed');
            break;
          case 'delete':
            $form[$collection][$config_change_type]['heading']['#value'] = $this
              ->formatPlural(count($config_names), '@count removed', '@count removed');
            break;
          case 'rename':
            $form[$collection][$config_change_type]['heading']['#value'] = $this
              ->formatPlural(count($config_names), '@count renamed', '@count renamed');
            break;
        }
        $form[$collection][$config_change_type]['list'] = [
          '#type' => 'table',
          '#header' => [
            $this
              ->t('Name'),
            $this
              ->t('Operations'),
          ],
        ];
        foreach ($config_names as $config_name) {
          if ($config_change_type == 'rename') {
            $names = $storage_comparer
              ->extractRenameNames($config_name);
            $route_options = [
              'source_name' => $names['old_name'],
              'target_name' => $names['new_name'],
            ];
            $config_name = $this
              ->t('@source_name to @target_name', [
              '@source_name' => $names['old_name'],
              '@target_name' => $names['new_name'],
            ]);
          }
          else {
            $route_options = [
              'source_name' => $config_name,
            ];
          }
          if ($collection != StorageInterface::DEFAULT_COLLECTION) {
            $route_name = 'config.diff_collection';
            $route_options['collection'] = $collection;
          }
          else {
            $route_name = 'config.diff';
          }
          $links['view_diff'] = [
            'title' => $this
              ->t('View differences'),
            'url' => Url::fromRoute($route_name, $route_options),
            'attributes' => [
              'class' => [
                'use-ajax',
              ],
              'data-dialog-type' => 'modal',
              'data-dialog-options' => json_encode([
                'width' => 700,
              ]),
            ],
          ];
          $form[$collection][$config_change_type]['list']['#rows'][] = [
            'name' => $config_name,
            'operations' => [
              'data' => [
                '#type' => 'operations',
                '#links' => $links,
              ],
            ],
          ];
        }
      }
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config_importer = new ConfigImporter($form_state
      ->get('storage_comparer'), $this->eventDispatcher, $this->configManager, $this->lock, $this->typedConfigManager, $this->moduleHandler, $this->moduleInstaller, $this->themeHandler, $this
      ->getStringTranslation(), $this->moduleExtensionList);
    if ($config_importer
      ->alreadyImporting()) {
      $this
        ->messenger()
        ->addStatus($this
        ->t('Another request may be synchronizing configuration already.'));
    }
    else {
      try {
        $sync_steps = $config_importer
          ->initialize();
        $batch = [
          'operations' => [],
          'finished' => [
            ConfigImporterBatch::class,
            'finish',
          ],
          'title' => t('Synchronizing configuration'),
          'init_message' => t('Starting configuration synchronization.'),
          'progress_message' => t('Completed step @current of @total.'),
          'error_message' => t('Configuration synchronization has encountered an error.'),
        ];
        foreach ($sync_steps as $sync_step) {
          $batch['operations'][] = [
            [
              ConfigImporterBatch::class,
              'process',
            ],
            [
              $config_importer,
              $sync_step,
            ],
          ];
        }
        batch_set($batch);
      } catch (ConfigImporterException $e) {

        // There are validation errors.
        $this
          ->messenger()
          ->addError($this
          ->t('The configuration cannot be imported because it failed validation for the following reasons:'));
        foreach ($config_importer
          ->getErrors() as $message) {
          $this
            ->messenger()
            ->addError($message);
        }
      }
    }
  }

  /**
   * Processes the config import batch and persists the importer.
   *
   * @param \Drupal\Core\Config\ConfigImporter $config_importer
   *   The batch config importer object to persist.
   * @param string $sync_step
   *   The synchronization step to do.
   * @param array $context
   *   The batch context.
   *
   * @deprecated in drupal:8.6.0 and is removed from drupal:9.0.0. Use
   *   \Drupal\Core\Config\Importer\ConfigImporterBatch::process() instead.
   *
   * @see https://www.drupal.org/node/2897299
   */
  public static function processBatch(ConfigImporter $config_importer, $sync_step, &$context) {
    @trigger_error('\\Drupal\\config\\Form\\ConfigSync::processBatch() deprecated in drupal:8.6.0 and will be removed before drupal:9.0.0. Use \\Drupal\\Core\\Config\\Importer\\ConfigImporterBatch::process() instead. See https://www.drupal.org/node/2897299', E_USER_DEPRECATED);
    ConfigImporterBatch::process($config_importer, $sync_step, $context);
  }

  /**
   * Finish batch.
   *
   * This function is a static function to avoid serializing the ConfigSync
   * object unnecessarily.
   *
   * @deprecated in drupal:8.6.0 and is removed from drupal:9.0.0. Use
   *   \Drupal\Core\Config\Importer\ConfigImporterBatch::finish() instead.
   *
   * @see https://www.drupal.org/node/2897299
   */
  public static function finishBatch($success, $results, $operations) {
    @trigger_error('\\Drupal\\config\\Form\\ConfigSync::finishBatch() deprecated in drupal:8.6.0 and will be removed before drupal:9.0.0. Use \\Drupal\\Core\\Config\\Importer\\ConfigImporterBatch::finish() instead. See https://www.drupal.org/node/2897299', E_USER_DEPRECATED);
    ConfigImporterBatch::finish($success, $results, $operations);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::$moduleHandler protected property The module handler.
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::$themeHandler protected property The theme handler.
ConfigSync::$typedConfigManager protected property The typed config manager.
ConfigSync::buildForm public function Form constructor. Overrides FormInterface::buildForm
ConfigSync::create public static function Instantiates a new instance of this class. Overrides FormBase::create
ConfigSync::finishBatch Deprecated public static function Finish batch.
ConfigSync::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ConfigSync::processBatch Deprecated public static function Processes the config import batch and persists the importer.
ConfigSync::submitForm public function Form submission handler. Overrides FormInterface::submitForm
ConfigSync::__construct public function Constructs the object.
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.