migrate_plus-8.x-5.x-dev/src/Entity/Migration.php

<?php

declare(strict_types=1);

namespace Drupal\migrate_plus\Entity;

use Drupal\Core\Cache\Cache;
use Drupal\Core\Config\Entity\ConfigEntityBase;
use Drupal\Core\Entity\EntityTypeInterface;

/**
 * Defines the Migration entity.
 *
 * The migration entity stores the information about a single migration, like
 * the source, process and destination plugins.
 *
 * @ConfigEntityType(
 *   id = "migration",
 *   label = @Translation("Migration"),
 *   entity_keys = {
 *     "id" = "id",
 *     "label" = "label",
 *     "weight" = "weight",
 *     "status" = "status"
 *   },
 *   config_export = {
 *     "id",
 *     "class",
 *     "idMap",
 *     "field_plugin_method",
 *     "cck_plugin_method",
 *     "migration_tags",
 *     "migration_group",
 *     "status",
 *     "label",
 *     "source",
 *     "process",
 *     "destination",
 *     "migration_dependencies",
 *   },
 * )
 */
class Migration extends ConfigEntityBase implements MigrationInterface {

  /**
   * The migration ID (machine name).
   */
  protected ?string $id;

  /**
   * The human-readable label for the migration.
   */
  protected ?string $label;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $values, $entity_type) {
    parent::__construct($values, $entity_type);

    // ID map value cannot be null because of
    // \Drupal\migrate\Plugin\Migration::getIdMap() and
    // \Drupal\migrate\Plugin\MigratePluginManager::createInstance()
    // Those core functions requires array value.
    // @phpstan-ignore variable.undefined
    $this->idMap = $values['idMap'] ?? [];
  }

  /**
   * {@inheritdoc}
   */
  protected function invalidateTagsOnSave($update): void {
    parent::invalidateTagsOnSave($update);
    \Drupal::service('plugin.manager.migration')->clearCachedDefinitions();

    // @todo remove after 10.1 and earlier support sunsets.
    Cache::invalidateTags(['migration_plugins']);
  }

  /**
   * {@inheritdoc}
   */
  protected static function invalidateTagsOnDelete(EntityTypeInterface $entity_type, array $entities): void {
    parent::invalidateTagsOnDelete($entity_type, $entities);
    \Drupal::service('plugin.manager.migration')->clearCachedDefinitions();

    // @todo remove after 10.1 and earlier support sunsets.
    Cache::invalidateTags(['migration_plugins']);
  }

  /**
   * Create a configuration entity from a core migration plugin's configuration.
   *
   * Note the list of properties being transplanted from the plugin instance or
   * definition into the Migration config entity must remain in sync with the
   * keys listed in the "config_export" annotation key of this class.
   *
   * @param string $plugin_id
   *   ID of a migration plugin managed by MigrationPluginManager.
   * @param string $new_plugin_id
   *   ID to use for the new configuration entity.
   *
   *   A Migration configuration entity (not saved to persistent storage).
   */
  public static function createEntityFromPlugin($plugin_id, $new_plugin_id): self {
    $entity_array = [];
    $migration_details = [];
    /** @var \Drupal\migrate\Plugin\MigrationPluginManagerInterface $plugin_manager */
    $plugin_manager = \Drupal::service('plugin.manager.migration');
    /** @var \Drupal\migrate\Plugin\Migration $migration_plugin */
    $migration_plugin = $plugin_manager->createInstance($plugin_id);
    $entity_array['id'] = $new_plugin_id;
    $plugin_definition = $migration_plugin->getPluginDefinition();
    $migration_details['class'] = $plugin_definition['class'];
    $entity_array['idMap'] = $plugin_definition['idMap'] ?? [];
    $entity_array['migration_tags'] = $migration_plugin->getMigrationTags();
    $entity_array['label'] = $migration_plugin->label();
    $entity_array['source'] = $migration_plugin->getSourceConfiguration();
    $entity_array['destination'] = $migration_plugin->getDestinationConfiguration();
    $entity_array['process'] = $migration_plugin->getProcess();
    $entity_array['migration_dependencies'] = $migration_plugin->getMigrationDependencies();
    return static::create($entity_array);
  }

}