You are here

Home » API reference » Migrate Tools 8.3 » MigrationController.php

class MigrationController in Migrate Tools 8.3

Same name and namespace in other branches
  1. 8.5 src/Controller/MigrationController.php \Drupal\migrate_tools\Controller\MigrationController
  2. 8.2 src/Controller/MigrationController.php \Drupal\migrate_tools\Controller\MigrationController
  3. 8.4 src/Controller/MigrationController.php \Drupal\migrate_tools\Controller\MigrationController

Returns responses for migrate_tools migration view routes.

Hierarchy

Expanded class hierarchy of MigrationController

File

src/Controller/MigrationController.php, line 16

Namespace

Drupal\migrate_tools\Controller
View source 
class MigrationController extends ControllerBase implements ContainerInjectionInterface {

  /**
   * Plugin manager for migration plugins.
   *
   * @var \Drupal\migrate_plus\Plugin\MigrationConfigEntityPluginManager
   */
  protected $migrationConfigEntityPluginManager;

  /**
   * Constructs a new MigrationController object.
   *
   * @param \Drupal\migrate_plus\Plugin\MigrationConfigEntityPluginManager $migration_config_entity_plugin_manager
   *   The plugin manager for config entity-based migrations.
   */
  public function __construct(MigrationConfigEntityPluginManager $migration_config_entity_plugin_manager) {
    $this->migrationConfigEntityPluginManager = $migration_config_entity_plugin_manager;
  }

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

  /**
   * Displays an overview of a migration entity.
   *
   * @param string $migration_group
   *   Machine name of the migration's group.
   * @param string $migration
   *   Machine name of the migration.
   *
   * @return array
   *   A render array as expected by drupal_render().
   */
  public function overview($migration_group, $migration) {

    /** @var MigrationInterface $migration */
    $migration = $this->migrationConfigEntityPluginManager
      ->createInstance($migration);
    $build['overview'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Overview'),
    ];
    $build['overview']['group'] = [
      '#title' => $this
        ->t('Group:'),
      '#markup' => Xss::filterAdmin($migration_group),
      '#type' => 'item',
    ];
    $build['overview']['description'] = [
      '#title' => $this
        ->t('Description:'),
      '#markup' => Xss::filterAdmin($migration
        ->label()),
      '#type' => 'item',
    ];
    $migration_dependencies = $migration
      ->getMigrationDependencies();
    if (!empty($migration_dependencies['required'])) {
      $build['overview']['dependencies'] = [
        '#title' => $this
          ->t('Migration Dependencies'),
        '#markup' => Xss::filterAdmin(implode(', ', $migration_dependencies['required'])),
        '#type' => 'item',
      ];
    }
    if (!empty($migration_dependencies['optional'])) {
      $build['overview']['soft_dependencies'] = [
        '#title' => $this
          ->t('Soft Migration Dependencies'),
        '#markup' => Xss::filterAdmin(implode(', ', $migration_dependencies['optional'])),
        '#type' => 'item',
      ];
    }
    return $build;
  }

  /**
   * Display source information of a migration entity.
   *
   * @param string $migration_group
   *   Machine name of the migration's group.
   * @param string $migration
   *   Machine name of the migration.
   *
   * @return array
   *   A render array as expected by drupal_render().
   */
  public function source($migration_group, $migration) {

    /** @var MigrationInterface $migration */
    $migration = $this->migrationConfigEntityPluginManager
      ->createInstance($migration);

    // Source field information.
    $build['source'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Source'),
      '#group' => 'detail',
      '#description' => $this
        ->t('<p>These are the fields available from the source of this migration task. The machine names listed here may be used as sources in the process pipeline.</p>'),
      '#attributes' => [
        'id' => 'migration-detail-source',
      ],
    ];
    $source = $migration
      ->getSourcePlugin();
    $build['source']['query'] = [
      '#type' => 'item',
      '#title' => $this
        ->t('Query'),
      '#markup' => '<pre>' . Xss::filterAdmin($source) . '</pre>',
    ];
    $header = [
      $this
        ->t('Machine name'),
      $this
        ->t('Description'),
    ];
    $rows = [];
    foreach ($source
      ->fields($migration) as $machine_name => $description) {
      $rows[] = [
        [
          'data' => Html::escape($machine_name),
        ],
        [
          'data' => Xss::filterAdmin($description),
        ],
      ];
    }
    $build['source']['fields'] = [
      '#theme' => 'table',
      '#header' => $header,
      '#rows' => $rows,
      '#empty' => $this
        ->t('No fields'),
    ];
    return $build;
  }

  /**
   * Display process information of a migration entity.
   *
   * @param string $migration_group
   *   Machine name of the migration's group.
   * @param string $migration
   *   Machine name of the migration.
   *
   * @return array
   *   A render array as expected by drupal_render().
   */
  public function process($migration_group, $migration) {

    /** @var MigrationInterface $migration */
    $migration = $this->migrationConfigEntityPluginManager
      ->createInstance($migration);

    // Process information.
    $build['process'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Process'),
    ];
    $header = [
      $this
        ->t('Destination'),
      $this
        ->t('Source'),
      $this
        ->t('Process plugin'),
      $this
        ->t('Default'),
    ];
    $rows = [];
    foreach ($migration
      ->getProcess() as $destination_id => $process_line) {
      $row = [];
      $row[] = [
        'data' => Html::escape($destination_id),
      ];
      if (isset($process_line[0]['source'])) {
        $row[] = [
          'data' => Xss::filterAdmin($process_line[0]['source']),
        ];
      }
      else {
        $row[] = '';
      }
      if (isset($process_line[0]['plugin'])) {
        $row[] = [
          'data' => Xss::filterAdmin($process_line[0]['plugin']),
        ];
      }
      else {
        $row[] = '';
      }
      if (isset($process_line[0]['default_value'])) {
        $row[] = [
          'data' => Xss::filterAdmin($process_line[0]['default_value']),
        ];
      }
      else {
        $row[] = '';
      }
      $rows[] = $row;
    }
    $build['process']['fields'] = [
      '#theme' => 'table',
      '#header' => $header,
      '#rows' => $rows,
      '#empty' => $this
        ->t('No process defined.'),
    ];
    return $build;
  }

  /**
   * Displays destination information of a migration entity.
   *
   * @param string $migration_group
   *   Machine name of the migration's group.
   * @param string $migration
   *   Machine name of the migration.
   *
   * @return array
   *   A render array as expected by drupal_render().
   */
  public function destination($migration_group, $migration) {

    /** @var MigrationInterface $migration */
    $migration = $this->migrationConfigEntityPluginManager
      ->createInstance($migration);

    // Destination field information.
    $build['destination'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Destination'),
      '#group' => 'detail',
      '#description' => $this
        ->t('<p>These are the fields available in the destination plugin of this migration task. The machine names are those available to be used as the keys in the process pipeline.</p>'),
      '#attributes' => [
        'id' => 'migration-detail-destination',
      ],
    ];
    $destination = $migration
      ->getDestinationPlugin();
    $build['destination']['type'] = [
      '#type' => 'item',
      '#title' => $this
        ->t('Type'),
      '#markup' => Xss::filterAdmin($destination
        ->getPluginId()),
    ];
    $header = [
      $this
        ->t('Machine name'),
      $this
        ->t('Description'),
    ];
    $rows = [];
    $destination_fields = $destination
      ->fields() ?: [];
    foreach ($destination_fields as $machine_name => $description) {
      $rows[] = [
        [
          'data' => Html::escape($machine_name),
        ],
        [
          'data' => Xss::filterAdmin($description),
        ],
      ];
    }
    $build['destination']['fields'] = [
      '#theme' => 'table',
      '#header' => $header,
      '#rows' => $rows,
      '#empty' => $this
        ->t('No fields'),
    ];
    return $build;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
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.
MigrationController::$migrationConfigEntityPluginManager protected property Plugin manager for migration plugins.
MigrationController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
MigrationController::destination public function Displays destination information of a migration entity.
MigrationController::overview public function Displays an overview of a migration entity.
MigrationController::process public function Display process information of a migration entity.
MigrationController::source public function Display source information of a migration entity.
MigrationController::__construct public function Constructs a new MigrationController object.
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.