class MigrationListBuilder in Migrate Tools 8.5
Same name and namespace in other branches
- 8 src/Controller/MigrationListBuilder.php \Drupal\migrate_tools\Controller\MigrationListBuilder
- 8.2 src/Controller/MigrationListBuilder.php \Drupal\migrate_tools\Controller\MigrationListBuilder
- 8.3 src/Controller/MigrationListBuilder.php \Drupal\migrate_tools\Controller\MigrationListBuilder
- 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
- class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityListBuilder
- class \Drupal\migrate_tools\Controller\MigrationListBuilder implements EntityHandlerInterface
- class \Drupal\Core\Config\Entity\ConfigEntityListBuilder
- class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
Expanded class hierarchy of MigrationListBuilder
File
- src/
Controller/ MigrationListBuilder.php, line 24
Namespace
Drupal\migrate_tools\ControllerView source
class MigrationListBuilder extends ConfigEntityListBuilder implements EntityHandlerInterface {
/**
* Default object for current_route_match service.
*
* @var \Drupal\Core\Routing\CurrentRouteMatch
*/
protected $currentRouteMatch;
/**
* Plugin manager for migration plugins.
*
* @var \Drupal\migrate\Plugin\MigrationPluginManagerInterface
*/
protected $migrationPluginManager;
/**
* The logger service.
*
* @var \Psr\Log\LoggerInterface
*/
protected $logger;
/**
* 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.
* @param \Drupal\migrate\Plugin\MigrationPluginManagerInterface $migration_plugin_manager
* The plugin manager for config entity-based migrations.
* @param \Psr\Log\LoggerInterface $logger
* The logger service.
*/
public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, CurrentRouteMatch $current_route_match, MigrationPluginManagerInterface $migration_plugin_manager, LoggerInterface $logger) {
parent::__construct($entity_type, $storage);
$this->currentRouteMatch = $current_route_match;
$this->migrationPluginManager = $migration_plugin_manager;
$this->logger = $logger;
}
/**
* {@inheritdoc}
*/
public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
return new static($entity_type, $container
->get('entity_type.manager')
->getStorage($entity_type
->id()), $container
->get('current_route_match'), $container
->get('plugin.manager.migration'), $container
->get('logger.channel.migrate_tools'));
}
/**
* Retrieve the migrations belonging to the appropriate group.
*
* @return array
* An array of entity IDs.
*/
protected function getEntityIds() {
$migration_group = $this->currentRouteMatch
->getParameter('migration_group');
$query = $this
->getStorage()
->getQuery()
->sort($this->entityType
->getKey('id'));
$migration_groups = MigrationGroup::loadMultiple();
if (array_key_exists($migration_group, $migration_groups)) {
$query
->condition('migration_group', $migration_group);
}
else {
$query
->notExists('migration_group');
}
// Only add the pager if a limit is specified.
if ($this->limit) {
$query
->pager($this->limit);
}
return $query
->execute();
}
/**
* 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');
$header['operations'] = $this
->t('Operations');
return $header;
}
/**
* Builds a row for a migration plugin.
*
* @param \Drupal\Core\Entity\EntityInterface $migration_entity
* The migration plugin for which to build the row.
*
* @return array|null
* A render array of the table row for displaying the plugin information.
*
* @see \Drupal\Core\Entity\EntityListController::render()
*/
public function buildRow(EntityInterface $migration_entity) {
try {
/** @var \Drupal\migrate\Plugin\MigrationInterface $migration */
$migration = $this->migrationPluginManager
->createInstance($migration_entity
->id());
$migration_group = $migration_entity
->get('migration_group');
if (!$migration_group) {
$migration_group = 'default';
}
$route_parameters = [
'migration_group' => $migration_group,
'migration' => $migration
->id(),
];
$row['label'] = [
'data' => [
'#type' => 'link',
'#title' => $migration
->label(),
'#url' => Url::fromRoute("entity.migration.overview", $route_parameters),
],
];
$row['machine_name'] = $migration
->id();
$row['status'] = $migration
->getStatusLabel();
} catch (\Exception $e) {
$this->logger
->warning('Migration entity id %id is malformed: %orig', [
'%id' => $migration_entity
->id(),
'%orig' => $e
->getMessage(),
]);
return NULL;
}
try {
// 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();
}
$row['messages'] = [
'data' => [
'#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 \Drupal\Core\Datetime\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'] = '';
}
$row['operations']['data'] = [
'#type' => 'dropbutton',
'#links' => [
'simple_form' => [
'title' => $this
->t('Execute'),
'url' => Url::fromRoute('migrate_tools.execute', [
'migration_group' => $migration_group,
'migration' => $migration
->id(),
]),
],
],
];
} catch (\Throwable $throwable) {
$this
->handleThrowable($row);
}
return $row;
}
/**
* Derive the row data.
*
* @param array $row
* The table row.
*/
protected function handleThrowable(array &$row) {
$row['status'] = $this
->t('No data found');
$row['total'] = $this
->t('N/A');
$row['imported'] = $this
->t('N/A');
$row['unprocessed'] = $this
->t('N/A');
$row['messages'] = $this
->t('N/A');
$row['last_imported'] = $this
->t('N/A');
$row['operations'] = $this
->t('N/A');
}
/**
* Add group route parameter.
*
* @param \Drupal\Core\Url $url
* The URL associated with an operation.
* @param string $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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfigEntityListBuilder:: |
public | function |
Gets this list's default operations. Overrides EntityListBuilder:: |
15 |
ConfigEntityListBuilder:: |
public | function |
Loads entities of this type from storage for listing. Overrides EntityListBuilder:: |
7 |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityHandlerBase:: |
protected | property | The module handler to invoke hooks on. | 2 |
EntityHandlerBase:: |
protected | function | Gets the module handler. | 2 |
EntityHandlerBase:: |
public | function | Sets the module handler for this handler. | |
EntityListBuilder:: |
protected | property | Information about the entity type. | |
EntityListBuilder:: |
protected | property | The entity type ID. | |
EntityListBuilder:: |
protected | property | The number of entities to list per page, or FALSE to list all entities. | 3 |
EntityListBuilder:: |
protected | property | The entity storage class. | 1 |
EntityListBuilder:: |
public | function | Builds a renderable list of operation links for the entity. | 2 |
EntityListBuilder:: |
protected | function | Ensures that a destination is present on the given URL. | |
EntityListBuilder:: |
protected | function | Gets the label of an entity. | |
EntityListBuilder:: |
public | function |
Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface:: |
2 |
EntityListBuilder:: |
public | function |
Gets the entity storage. Overrides EntityListBuilderInterface:: |
|
EntityListBuilder:: |
protected | function | Gets the title of the page. | 1 |
EntityListBuilder:: |
public | function |
Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilderInterface:: |
16 |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
MigrationListBuilder:: |
protected | property | Default object for current_route_match service. | |
MigrationListBuilder:: |
protected | property | The logger service. | |
MigrationListBuilder:: |
protected | property | Plugin manager for migration plugins. | |
MigrationListBuilder:: |
protected | function | Add group route parameter. | |
MigrationListBuilder:: |
public | function |
Builds the header row for the entity listing. Overrides EntityListBuilder:: |
|
MigrationListBuilder:: |
public | function |
Builds a row for a migration plugin. Overrides EntityListBuilder:: |
|
MigrationListBuilder:: |
public static | function |
Instantiates a new instance of this entity handler. Overrides EntityListBuilder:: |
|
MigrationListBuilder:: |
protected | function |
Retrieve the migrations belonging to the appropriate group. Overrides EntityListBuilder:: |
|
MigrationListBuilder:: |
protected | function | Derive the row data. | |
MigrationListBuilder:: |
public | function |
Constructs a new EntityListBuilder object. Overrides EntityListBuilder:: |
|
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |