You are here

Home » API reference » Drupal-to-Drupal data migration 8.3 » SourceSelectForm.php

class SourceSelectForm in Drupal-to-Drupal data migration 8.3

Defines a multi-step form for performing direct site upgrades.

Hierarchy

Expanded class hierarchy of SourceSelectForm

File

migrate_d2d_ui/src/Form/SourceSelectForm.php, line 13

Namespace

Drupal\migrate_d2d_ui\Form
View source 
class SourceSelectForm extends DrupalMigrateForm {
  use MigrationConfigurationTrait;

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

  /**
   * Constructs the SourceSelectForm.
   *
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer service.
   */
  public function __construct(RendererInterface $renderer) {
    $this->renderer = $renderer;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $drivers = $this
      ->getDatabaseTypes();
    $drivers_keys = array_keys($drivers);

    // @todo https://www.drupal.org/node/2678510 Because this is a multi-step
    //   form, the form is not rebuilt during submission. Ideally we would get
    //   the chosen driver from form input, if available, in order to use
    //   #limit_validation_errors in the same way
    //   \Drupal\Core\Installer\Form\SiteSettingsForm does.
    $default_driver = current($drivers_keys);
    $default_options = [];
    $form['database'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Source database'),
      '#description' => $this
        ->t('Provide credentials for the database of the Drupal site you want to import.'),
      '#open' => TRUE,
    ];
    $form['database']['driver'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Database type'),
      '#required' => TRUE,
      '#default_value' => $default_driver,
    ];
    if (count($drivers) == 1) {
      $form['database']['driver']['#disabled'] = TRUE;
    }

    // Add driver-specific configuration options.
    foreach ($drivers as $key => $driver) {
      $form['database']['driver']['#options'][$key] = $driver
        ->name();
      $form['database']['settings'][$key] = $driver
        ->getFormOptions($default_options);

      // @todo https://www.drupal.org/node/2678510 Using
      //   #limit_validation_errors in the submit does not work so it is not
      //   possible to require the database and username for mysql and pgsql.
      //   This is because this is a multi-step form.
      $form['database']['settings'][$key]['database']['#required'] = FALSE;
      $form['database']['settings'][$key]['username']['#required'] = FALSE;
      $form['database']['settings'][$key]['#prefix'] = '<h2 class="js-hide">' . $this
        ->t('@driver_name settings', [
        '@driver_name' => $driver
          ->name(),
      ]) . '</h2>';
      $form['database']['settings'][$key]['#type'] = 'container';
      $form['database']['settings'][$key]['#tree'] = TRUE;
      $form['database']['settings'][$key]['advanced_options']['#parents'] = [
        $key,
      ];
      $form['database']['settings'][$key]['#states'] = [
        'visible' => [
          ':input[name=driver]' => [
            'value' => $key,
          ],
        ],
      ];

      // Move the host fields out of advanced settings.
      if (isset($form['database']['settings'][$key]['advanced_options']['host'])) {
        $form['database']['settings'][$key]['host'] = $form['database']['settings'][$key]['advanced_options']['host'];
        $form['database']['settings'][$key]['host']['#title'] = 'Database host';
        $form['database']['settings'][$key]['host']['#weight'] = -1;
        unset($form['database']['settings'][$key]['database']['#default_value']);
        unset($form['database']['settings'][$key]['advanced_options']['host']);
      }
    }
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['save'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Review upgrade'),
    ];
    return $form;
  }

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

    // Retrieve the database driver from the form, use reflection to get the
    // namespace, and then construct a valid database array the same as in
    // settings.php.
    $driver = $form_state
      ->getValue('driver');
    $drivers = $this
      ->getDatabaseTypes();
    $reflection = new \ReflectionClass($drivers[$driver]);
    $install_namespace = $reflection
      ->getNamespaceName();
    $database = $form_state
      ->getValue($driver);

    // Cut the trailing \Install from namespace.
    $database['namespace'] = substr($install_namespace, 0, strrpos($install_namespace, '\\'));
    $database['driver'] = $driver;

    // Validate the driver settings and just end here if we have any issues.
    if ($errors = $drivers[$driver]
      ->validateDatabaseSettings($database)) {
      foreach ($errors as $name => $message) {
        $form_state
          ->setErrorByName($name, $message);
      }
      return;
    }
    try {
      $connection = $this
        ->getConnection($database);
      $version = $this
        ->getLegacyDrupalVersion($connection);
      if (!$version) {
        $form_state
          ->setErrorByName($database['driver'] . '][0', $this
          ->t('Source database does not contain a recognizable Drupal version.'));
      }
      else {
        $cached_values = $form_state
          ->getTemporaryValue('wizard');
        $cached_values['version'] = $version;
        $cached_values['database'] = $database;
        $form_state
          ->setTemporaryValue('wizard', $cached_values);
      }
    } catch (\Exception $e) {
      $error_message = [
        '#type' => 'inline_template',
        '#template' => '{% trans %}Resolve the issue below to continue the upgrade.{% endtrans%}{{ errors }}',
        '#context' => [
          'errors' => [
            '#theme' => 'item_list',
            '#items' => [
              $e
                ->getMessage(),
            ],
          ],
        ],
      ];
      $form_state
        ->setErrorByName($database['driver'] . '][0', $this->renderer
        ->renderPlain($error_message));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $cached_values = $form_state
      ->getTemporaryValue('wizard');
    $connection = $this
      ->getConnection($cached_values['database']);

    // Store the system data in form storage.
    $form_state
      ->set('system_data', $this
      ->getSystemData($connection));
    $this
      ->createDatabaseStateSettings($cached_values['database'], $cached_values['version']);
    $migration_plugins = $this
      ->getMigrations('', $cached_values['version']);

    // Convert the migration object into an array so that it can be stored in
    // form storage.
    foreach ($migration_plugins as $migration) {
      $cached_values['migrations'][$migration
        ->id()] = (string) $migration
        ->label();
    }
    $form_state
      ->setTemporaryValue('wizard', $cached_values);
  }

  /**
   * Returns all supported database driver installer objects.
   *
   * @return \Drupal\Core\Database\Install\Tasks[]
   *   An array of available database driver installer objects.
   */
  protected function getDatabaseTypes() {

    // Make sure the install API is available.
    include_once DRUPAL_ROOT . '/core/includes/install.inc';
    return drupal_get_database_types();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
DrupalMigrateForm::$sourceConnection protected property Cached database connection.
DrupalMigrateForm::connection protected function Gets the database connection for the source Drupal database.
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.
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.
MigrationConfigurationTrait::$configFactory protected property The config factory service.
MigrationConfigurationTrait::$followUpMigrationTags protected property The follow-up migration tags.
MigrationConfigurationTrait::$migrationPluginManager protected property The migration plugin manager service.
MigrationConfigurationTrait::$state protected property The state service.
MigrationConfigurationTrait::createDatabaseStateSettings protected function Creates the necessary state entries for SqlBase::getDatabase() to work.
MigrationConfigurationTrait::getConfigFactory protected function Gets the config factory service.
MigrationConfigurationTrait::getConnection protected function Gets the database connection for the source Drupal database.
MigrationConfigurationTrait::getFollowUpMigrationTags protected function Returns the follow-up migration tags.
MigrationConfigurationTrait::getLegacyDrupalVersion public static function Determines what version of Drupal the source database contains.
MigrationConfigurationTrait::getMigrationPluginManager protected function Gets the migration plugin manager service.
MigrationConfigurationTrait::getMigrations protected function Gets the migrations for import.
MigrationConfigurationTrait::getState protected function Gets the state service.
MigrationConfigurationTrait::getSystemData protected function Gets the system data from the system table of the source Drupal database.
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.
SourceSelectForm::$renderer protected property The renderer service.
SourceSelectForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
SourceSelectForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
SourceSelectForm::getDatabaseTypes protected function Returns all supported database driver installer objects.
SourceSelectForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SourceSelectForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
SourceSelectForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
SourceSelectForm::__construct public function Constructs the SourceSelectForm.
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.