class MigratePluginManager
Manages migrate plugins.
Hierarchy
- class \Drupal\Component\Plugin\PluginManagerBase implements \Drupal\Component\Plugin\PluginManagerInterface uses \Drupal\Component\Plugin\Discovery\DiscoveryTrait- class \Drupal\Core\Plugin\DefaultPluginManager implements \Drupal\Component\Plugin\PluginManagerInterface, \Drupal\Component\Plugin\Discovery\CachedDiscoveryInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Component\Plugin\Discovery\DiscoveryCachedTrait, \Drupal\Core\Cache\UseCacheBackendTrait extends \Drupal\Component\Plugin\PluginManagerBase- class \Drupal\migrate\Plugin\MigratePluginManager implements \Drupal\migrate\Plugin\MigratePluginManagerInterface extends \Drupal\Core\Plugin\DefaultPluginManager
 
 
- class \Drupal\Core\Plugin\DefaultPluginManager implements \Drupal\Component\Plugin\PluginManagerInterface, \Drupal\Component\Plugin\Discovery\CachedDiscoveryInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Component\Plugin\Discovery\DiscoveryCachedTrait, \Drupal\Core\Cache\UseCacheBackendTrait extends \Drupal\Component\Plugin\PluginManagerBase
Expanded class hierarchy of MigratePluginManager
See also
hook_migrate_info_alter()
\Drupal\migrate\Attribute\MigrateSource
\Drupal\migrate\Plugin\MigrateSourceInterface
\Drupal\migrate\Plugin\migrate\source\SourcePluginBase
\Drupal\migrate\Attribute\MigrateProcess
\Drupal\migrate\Plugin\MigrateProcessInterface
\Drupal\migrate\Plugin\migrate\process\ProcessPluginBase
Related topics
4 files declare their use of MigratePluginManager
- FieldMigration.php in core/modules/ migrate_drupal/ src/ Plugin/ migrate/ FieldMigration.php 
- MigrateFieldPluginManager.php in core/modules/ migrate_drupal/ src/ Plugin/ MigrateFieldPluginManager.php 
- MigrationPluginConfigurationTest.php in core/modules/ migrate/ tests/ src/ Kernel/ Plugin/ MigrationPluginConfigurationTest.php 
- MigrationPluginListTest.php in core/modules/ migrate/ tests/ src/ Kernel/ Plugin/ MigrationPluginListTest.php 
1 string reference to 'MigratePluginManager'
- migrate.services.yml in core/modules/ migrate/ migrate.services.yml 
- core/modules/migrate/migrate.services.yml
2 services use MigratePluginManager
- plugin.manager.migrate.id_map in core/modules/ migrate/ migrate.services.yml 
- Drupal\migrate\Plugin\MigratePluginManager
- plugin.manager.migrate.process in core/modules/ migrate/ migrate.services.yml 
- Drupal\migrate\Plugin\MigratePluginManager
File
- 
              core/modules/ migrate/ src/ Plugin/ MigratePluginManager.php, line 26 
Namespace
Drupal\migrate\PluginView source
class MigratePluginManager extends DefaultPluginManager implements MigratePluginManagerInterface {
  
  /**
   * Constructs a MigratePluginManager object.
   *
   * @param string $type
   *   The type of the plugin: row, source, process, destination, entity_field,
   *   id_map.
   * @param \Traversable $namespaces
   *   An object that implements \Traversable which contains the root paths
   *   keyed by the corresponding namespace to look for plugin implementations.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
   *   Cache backend instance to use.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler to invoke the alter hook with.
   * @param string $attribute
   *   (optional) The attribute class name. Defaults to
   *   'Drupal\Component\Plugin\Attribute\PluginID'.
   * @param string $annotation
   *   (optional) The annotation class name. Defaults to
   *   'Drupal\Component\Annotation\PluginID'.
   */
  public function __construct($type, \Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, $attribute = PluginID::class, $annotation = 'Drupal\\Component\\Annotation\\PluginID') {
    if (!is_subclass_of($attribute, AttributeInterface::class)) {
      // Backward compatibility.
      $annotation = $attribute;
      $attribute = PluginID::class;
    }
    parent::__construct("Plugin/migrate/{$type}", $namespaces, $module_handler, NULL, $attribute, $annotation);
    $this->alterInfo('migrate_' . $type . '_info');
    $this->setCacheBackend($cache_backend, 'migrate_plugins_' . $type);
  }
  
  /**
   * {@inheritdoc}
   */
  public function createInstance($plugin_id, array $configuration = [], ?MigrationInterface $migration = NULL) {
    $plugin_definition = $this->getDefinition($plugin_id);
    $plugin_class = DefaultFactory::getPluginClass($plugin_id, $plugin_definition);
    // If the plugin provides a factory method, pass the container to it.
    if (is_subclass_of($plugin_class, 'Drupal\\Core\\Plugin\\ContainerFactoryPluginInterface')) {
      $plugin = $plugin_class::create(\Drupal::getContainer(), $configuration, $plugin_id, $plugin_definition, $migration);
    }
    else {
      $plugin = new $plugin_class($configuration, $plugin_id, $plugin_definition, $migration);
    }
    return $plugin;
  }
}Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides | 
|---|---|---|---|---|---|
| DefaultPluginManager::$additionalAnnotationNamespaces | protected | property | Additional annotation namespaces. | ||
| 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::$defaults | protected | property | A set of defaults to be referenced by $this->processDefinition(). | 11 | |
| DefaultPluginManager::$moduleExtensionList | protected | property | The module extension list. | ||
| DefaultPluginManager::$moduleHandler | protected | property | The module handler to invoke the alter hook. | 1 | |
| DefaultPluginManager::$namespaces | protected | property | An object of root paths that are traversable. | ||
| DefaultPluginManager::$pluginDefinitionAnnotationName | protected | property | The name of the annotation that contains the plugin definition. | ||
| DefaultPluginManager::$pluginDefinitionAttributeName | protected | property | The name of the attribute that contains the plugin definition. | ||
| DefaultPluginManager::$pluginInterface | protected | property | The interface each plugin should implement. | 1 | |
| DefaultPluginManager::$subdir | protected | property | The subdirectory within a namespace to look for plugins. | ||
| DefaultPluginManager::alterDefinitions | protected | function | Invokes the hook to alter the definitions if the alter hook is set. | 4 | |
| DefaultPluginManager::alterInfo | protected | function | Sets the alter hook name. | ||
| DefaultPluginManager::clearCachedDefinitions | public | function | Clears static and persistent plugin definition caches. | Overrides CachedDiscoveryInterface::clearCachedDefinitions | 10 | 
| DefaultPluginManager::extractProviderFromDefinition | protected | function | Extracts the provider from a plugin definition. | ||
| DefaultPluginManager::findDefinitions | protected | function | Finds plugin definitions. | 7 | |
| 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::getDiscovery | protected | function | Gets the plugin discovery. | Overrides PluginManagerBase::getDiscovery | 16 | 
| DefaultPluginManager::getFactory | protected | function | Gets the plugin factory. | Overrides PluginManagerBase::getFactory | |
| DefaultPluginManager::processDefinition | public | function | Performs extra processing on plugin definitions. | 16 | |
| DefaultPluginManager::providerExists | protected | function | Determines if the provider of a definition exists. | 5 | |
| 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 | |||
| MigratePluginManager::createInstance | public | function | Creates a plugin instance based on the provided ID and configuration. | Overrides PluginManagerBase::createInstance | 1 | 
| MigratePluginManager::__construct | public | function | Constructs a MigratePluginManager object. | Overrides DefaultPluginManager::__construct | 3 | 
| 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 preconfigured plugin instance for a particular runtime condition. | ||
| PluginManagerBase::getFallbackPluginId | protected | function | Gets a fallback id for a missing plugin. | 6 | |
| PluginManagerBase::getInstance | public | function | Gets or creates a plugin instance that satisfies the given options. | 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. | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
