You are here

Home » API reference » Migrate Tools 8 » MigrationListBuilder.php

class MigrationListBuilder in Migrate Tools 8

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

Provides a listing of migration entities in a given group.

@package Drupal\migrate_tools\Controller

Hierarchy

Expanded class hierarchy of MigrationListBuilder

File

src/Controller/MigrationListBuilder.php, line 26
Contains Drupal\migrate_tools\Controller\MigrationListBuilder.

Namespace

Drupal\migrate_tools\Controller
View source 
class MigrationListBuilder extends ConfigEntityListBuilder implements EntityHandlerInterface {

  /**
   * @var \Drupal\Core\Routing\CurrentRouteMatch
   */
  protected $currentRouteMatch;

  /**
   * Constructs a new EntityListBuilder object.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The entity storage class.
   * @param \Drupal\Core\Routing\CurrentRouteMatch $current_route_match
   *   The Current route match service.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, CurrentRouteMatch $current_route_match) {
    parent::__construct($entity_type, $storage);
    $this->currentRouteMatch = $current_route_match;
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container
      ->get('entity.manager')
      ->getStorage($entity_type
      ->id()), $container
      ->get('current_route_match'));
  }

  /**
   * Builds the header row for the entity listing.
   *
   * @return array
   *   A render array structure of header strings.
   *
   * @see Drupal\Core\Entity\EntityListController::render()
   */
  public function buildHeader() {
    $header['label'] = $this
      ->t('Migration');
    $header['machine_name'] = $this
      ->t('Machine Name');
    $header['status'] = $this
      ->t('Status');
    $header['total'] = $this
      ->t('Total');
    $header['imported'] = $this
      ->t('Imported');
    $header['unprocessed'] = $this
      ->t('Unprocessed');
    $header['messages'] = $this
      ->t('Messages');
    $header['last_imported'] = $this
      ->t('Last Imported');
    return $header;

    // + parent::buildHeader();
  }

  /**
   * Builds a row for an entity in the entity listing.
   *
   * @param \Drupal\migrate\Entity\EntityInterface $migration
   *   The entity for which to build the row.
   *
   * @return array
   *   A render array of the table row for displaying the entity.
   *
   * @see Drupal\Core\Entity\EntityListController::render()
   */
  public function buildRow(EntityInterface $migration) {
    $row['label'] = $migration
      ->label();
    $row['machine_name'] = $migration
      ->id();
    $row['status'] = $migration
      ->getStatusLabel();

    // Derive the stats
    $source_plugin = $migration
      ->getSourcePlugin();
    $row['total'] = $source_plugin
      ->count();
    $map = $migration
      ->getIdMap();
    $row['imported'] = $map
      ->importedCount();

    // -1 indicates uncountable sources.
    if ($row['total'] == -1) {
      $row['total'] = $this
        ->t('N/A');
      $row['unprocessed'] = $this
        ->t('N/A');
    }
    else {
      $row['unprocessed'] = $row['total'] - $map
        ->processedCount();
    }
    $migration_group = $migration
      ->getThirdPartySetting('migrate_plus', 'migration_group');
    if (!$migration_group) {
      $migration_group = 'default';
    }
    $route_parameters = array(
      'migration_group' => $migration_group,
      'migration' => $migration
        ->id(),
    );
    $row['messages'] = array(
      'data' => array(
        '#type' => 'link',
        '#title' => $map
          ->messageCount(),
        '#url' => Url::fromRoute("migrate_tools.messages", $route_parameters),
      ),
    );
    $migrate_last_imported_store = \Drupal::keyValue('migrate_last_imported');
    $last_imported = $migrate_last_imported_store
      ->get($migration
      ->id(), FALSE);
    if ($last_imported) {

      /** @var DateFormatter $date_formatter */
      $date_formatter = \Drupal::service('date.formatter');
      $row['last_imported'] = $date_formatter
        ->format($last_imported / 1000, 'custom', 'Y-m-d H:i:s');
    }
    else {
      $row['last_imported'] = '';
    }
    return $row;

    // + parent::buildRow($migration);
  }

  /**
   * {@inheritdoc}
   */
  public function load() {
    $entity_ids = $this
      ->getEntityIds();

    // We're already sorting the entities properly in loadMultiple, and
    // ConfigEntityListBuilder's load() messes it up with an extra sort(). So,
    // simply take the entities in the order loaded.
    $entities = $this->storage
      ->loadMultipleOverrideFree($entity_ids);
    return $entities;
  }

  /**
   * Retrieve the migrations belonging to the appropriate group.
   *
   * @return array
   *   An array of entity IDs.
   */
  protected function getEntityIds() {
    $query = $this
      ->getStorage()
      ->getQuery('OR');
    $keys = $this->entityType
      ->getKeys();
    $migration_group = $this->currentRouteMatch
      ->getParameter('migration_group');

    // Add groupless migrations to the default group.
    if ($migration_group == 'default') {
      $query
        ->notExists('third_party_settings.migrate_plus.migration_group');
    }
    return $query
      ->condition('third_party_settings.migrate_plus.migration_group', $migration_group)
      ->sort($keys['id'])
      ->pager($this->limit)
      ->execute();
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultOperations(EntityInterface $entity) {
    $operations = parent::getDefaultOperations($entity);
    $migration_group = $entity
      ->getThirdPartySetting('migrate_plus', 'migration_group');
    if (!$migration_group) {
      $migration_group = 'default';
    }

    //    $this->addGroupParameter($operations['edit']['url'], $migration_group);
    $this
      ->addGroupParameter($operations['delete']['url'], $migration_group);
    return $operations;
  }

  /**
   * @param \Drupal\Core\Url $url
   *   The URL associated with an operation.
   *
   * @param $migration_group
   *   The migration's parent group.
   */
  protected function addGroupParameter(Url $url, $migration_group) {
    if (!$migration_group) {
      $migration_group = 'default';
    }
    $route_parameters = $url
      ->getRouteParameters() + [
      'migration_group' => $migration_group,
    ];
    $url
      ->setRouteParameters($route_parameters);
  }

}

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
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on. 2
EntityHandlerBase::moduleHandler protected function Gets the module handler. 2
EntityHandlerBase::setModuleHandler public function Sets the module handler for this handler.
EntityListBuilder::$entityType protected property Information about the entity type.
EntityListBuilder::$entityTypeId protected property The entity type ID.
EntityListBuilder::$limit protected property The number of entities to list per page, or FALSE to list all entities. 3
EntityListBuilder::$storage protected property The entity storage class. 1
EntityListBuilder::buildOperations public function Builds a renderable list of operation links for the entity. 2
EntityListBuilder::ensureDestination protected function Ensures that a destination is present on the given URL.
EntityListBuilder::getLabel Deprecated protected function Gets the label of an entity.
EntityListBuilder::getOperations public function Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface::getOperations 2
EntityListBuilder::getStorage public function Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
EntityListBuilder::getTitle protected function Gets the title of the page. 1
EntityListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilderInterface::render 16
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
MigrationListBuilder::$currentRouteMatch protected property
MigrationListBuilder::addGroupParameter protected function
MigrationListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
MigrationListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
MigrationListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
MigrationListBuilder::getDefaultOperations public function Gets this list's default operations. Overrides ConfigEntityListBuilder::getDefaultOperations
MigrationListBuilder::getEntityIds protected function Retrieve the migrations belonging to the appropriate group. Overrides EntityListBuilder::getEntityIds
MigrationListBuilder::load public function Loads entities of this type from storage for listing. Overrides ConfigEntityListBuilder::load
MigrationListBuilder::__construct public function Constructs a new EntityListBuilder object. Overrides EntityListBuilder::__construct
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.