class MigrationPluginManager in Drupal 9

Manages migration plugins.

Analyzes migration definitions to ensure that the source plugin of any migration tagged with particular tags ('Drupal 6' or 'Drupal 7' by default) defines a source_module property in its plugin annotation. This is done in order to support the Migrate Drupal UI, which needs to know which modules "own" the data being migrated into Drupal 8, on both the source and destination sides.

@todo Enforce the destination_module property too, in https://www.drupal.org/project/drupal/issues/2923810.

Hierarchy

• class \Drupal\Component\Plugin\PluginManagerBase implements PluginManagerInterface uses DiscoveryTrait
  • class \Drupal\Core\Plugin\DefaultPluginManager implements CachedDiscoveryInterface, PluginManagerInterface, CacheableDependencyInterface uses DiscoveryCachedTrait, UseCacheBackendTrait
    • class \Drupal\migrate\Plugin\MigrationPluginManager implements MigrateBuildDependencyInterface, MigrationPluginManagerInterface
      • class \Drupal\migrate_drupal\MigrationPluginManager

File

core/modules/migrate_drupal/src/MigrationPluginManager.php, line 26

Namespace

Drupal\migrate_drupal

class MigrationPluginManager extends BaseMigrationPluginManager {

  /**
   * The Migrate source plugin manager service.
   *
   * @var \Drupal\migrate\Plugin\MigrateSourcePluginManager
   */
  protected $sourceManager;

  /**
   * The config factory service.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * The migration tags which will trigger source_module enforcement.
   *
   * @var string[]
   */
  protected $enforcedSourceModuleTags;

  /**
   * MigrationPluginManager constructor.
   *
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler service.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
   *   The cache backend.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager service.
   * @param \Drupal\migrate\Plugin\MigrateSourcePluginManager $source_manager
   *   The Migrate source plugin manager service.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory service.
   */
  public function __construct(ModuleHandlerInterface $module_handler, CacheBackendInterface $cache_backend, LanguageManagerInterface $language_manager, MigrateSourcePluginManager $source_manager, ConfigFactoryInterface $config_factory) {
    parent::__construct($module_handler, $cache_backend, $language_manager);
    $this->sourceManager = $source_manager;
    $this->configFactory = $config_factory;
  }

  /**
   * Returns the migration tags that trigger source_module enforcement.
   *
   * @return string[]
   */
  protected function getEnforcedSourceModuleTags() {
    if ($this->enforcedSourceModuleTags === NULL) {
      $this->enforcedSourceModuleTags = $this->configFactory
        ->get('migrate_drupal.settings')
        ->get('enforce_source_module_tags') ?: [];
    }
    return $this->enforcedSourceModuleTags;
  }

  /**
   * {@inheritdoc}
   */
  public function processDefinition(&$definition, $plugin_id) {
    parent::processDefinition($definition, $plugin_id);

    // If the migration has no tags, we don't need to enforce the source_module
    // annotation property.
    if (empty($definition['migration_tags'])) {
      return;
    }

    // Check if the migration has any of the tags that trigger source_module
    // enforcement.
    $applied_tags = array_intersect($this
      ->getEnforcedSourceModuleTags(), $definition['migration_tags']);
    if ($applied_tags) {

      // Throw an exception if the source plugin definition does not define a
      // source_module.
      $source_id = $definition['source']['plugin'];
      $source_definition = $this->sourceManager
        ->getDefinition($source_id);
      if (empty($source_definition['source_module'])) {
        throw new BadPluginDefinitionException($source_id, 'source_module');
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DefaultPluginManager::$additionalAnnotationNamespaces	protected	property	Additional namespaces the annotation discovery mechanism should scan for annotation definitions.
DefaultPluginManager::$alterHook	protected	property	Name of the alter hook if one should be invoked.
DefaultPluginManager::$cacheKey	protected	property	The cache key.
DefaultPluginManager::$cacheTags	protected	property	An array of cache tags to use for the cached definitions.
DefaultPluginManager::$namespaces	protected	property	An object that implements \Traversable which contains the root paths keyed by the corresponding namespace to look for plugin implementations.
DefaultPluginManager::$pluginDefinitionAnnotationName	protected	property	The name of the annotation that contains the plugin definition.
DefaultPluginManager::$subdir	protected	property	The subdirectory within a namespace to look for plugins, or FALSE if the plugins are in the top level of the namespace.
DefaultPluginManager::alterDefinitions	protected	function	Invokes the hook to alter the definitions if the alter hook is set.	1
DefaultPluginManager::alterInfo	protected	function	Sets the alter hook name.
DefaultPluginManager::clearCachedDefinitions	public	function	Clears static and persistent plugin definition caches. Overrides CachedDiscoveryInterface::clearCachedDefinitions	6
DefaultPluginManager::extractProviderFromDefinition	protected	function	Extracts the provider from a plugin definition.
DefaultPluginManager::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
DefaultPluginManager::getCachedDefinitions	protected	function	Returns the cached plugin definitions of the decorated discovery class.
DefaultPluginManager::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
DefaultPluginManager::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
DefaultPluginManager::getDefinitions	public	function	Gets the definition of all plugins for this type. Overrides DiscoveryTrait::getDefinitions	2
DefaultPluginManager::getFactory	protected	function	Gets the plugin factory. Overrides PluginManagerBase::getFactory
DefaultPluginManager::providerExists	protected	function	Determines if the provider of a definition exists.	3
DefaultPluginManager::setCacheBackend	public	function	Initialize the cache backend.
DefaultPluginManager::setCachedDefinitions	protected	function	Sets a cache of plugin definitions for the decorated discovery class.
DefaultPluginManager::useCaches	public	function	Disable the use of caches. Overrides CachedDiscoveryInterface::useCaches	1
DiscoveryCachedTrait::$definitions	protected	property	Cached definitions array.	1
DiscoveryCachedTrait::getDefinition	public	function	Overrides DiscoveryTrait::getDefinition	3
DiscoveryTrait::doGetDefinition	protected	function	Gets a specific plugin definition.
DiscoveryTrait::hasDefinition	public	function
MigrationPluginManager::$configFactory	protected	property	The config factory service.
MigrationPluginManager::$defaults	protected	property	Provides default values for migrations. Overrides DefaultPluginManager::$defaults
MigrationPluginManager::$enforcedSourceModuleTags	protected	property	The migration tags which will trigger source_module enforcement.
MigrationPluginManager::$moduleHandler	protected	property	The module handler. Overrides DefaultPluginManager::$moduleHandler
MigrationPluginManager::$pluginInterface	protected	property	The interface the plugins should implement. Overrides DefaultPluginManager::$pluginInterface
MigrationPluginManager::$sourceManager	protected	property	The Migrate source plugin manager service.
MigrationPluginManager::addDependency	protected	function	Add one or more dependencies to a graph.
MigrationPluginManager::buildDependencyMigration	public	function	Builds a dependency tree for the migrations and set their order. Overrides MigrateBuildDependencyInterface::buildDependencyMigration
MigrationPluginManager::createInstance	public	function	Creates a pre-configured instance of a plugin. Overrides PluginManagerBase::createInstance
MigrationPluginManager::createInstances	public	function	Create pre-configured instance of plugin derivatives. Overrides MigrationPluginManagerInterface::createInstances
MigrationPluginManager::createInstancesByTag	public	function	Create migrations given a tag. Overrides MigrationPluginManagerInterface::createInstancesByTag
MigrationPluginManager::createStubMigration	public	function	Creates a stub migration plugin from a definition array. Overrides MigrationPluginManagerInterface::createStubMigration
MigrationPluginManager::expandPluginIds	protected	function	Expand derivative migration dependencies.
MigrationPluginManager::findDefinitions	protected	function	Finds plugin definitions. Overrides DefaultPluginManager::findDefinitions
MigrationPluginManager::getDiscovery	protected	function	Gets the plugin discovery. Overrides DefaultPluginManager::getDiscovery
MigrationPluginManager::getEnforcedSourceModuleTags	protected	function	Returns the migration tags that trigger source_module enforcement.
MigrationPluginManager::processDefinition	public	function	Performs extra processing on plugin definitions. Overrides DefaultPluginManager::processDefinition
MigrationPluginManager::__construct	public	function	MigrationPluginManager constructor. Overrides MigrationPluginManager::__construct
PluginManagerBase::$discovery	protected	property	The object that discovers plugins managed by this manager.
PluginManagerBase::$factory	protected	property	The object that instantiates plugins managed by this manager.
PluginManagerBase::$mapper	protected	property	The object that returns the preconfigured plugin instance appropriate for a particular runtime condition.
PluginManagerBase::getInstance	public	function	Gets a preconfigured instance of a plugin. Overrides MapperInterface::getInstance	6
PluginManagerBase::handlePluginNotFound	protected	function	Allows plugin managers to specify custom behavior if a plugin is not found.	1
UseCacheBackendTrait::$cacheBackend	protected	property	Cache backend instance.
UseCacheBackendTrait::$useCaches	protected	property	Flag whether caches should be used or skipped.
UseCacheBackendTrait::cacheGet	protected	function	Fetches from the cache backend, respecting the use caches flag.
UseCacheBackendTrait::cacheSet	protected	function	Stores data in the persistent cache, respecting the use caches flag.