MigratePluginManager.php

Same filename in other branches
  1. 9 core/modules/migrate/src/Plugin/MigratePluginManager.php
  2. 8.9.x core/modules/migrate/src/Plugin/MigratePluginManager.php
  3. 10 core/modules/migrate/src/Plugin/MigratePluginManager.php

Namespace

Drupal\migrate\Plugin

File

core/modules/migrate/src/Plugin/MigratePluginManager.php

View source
<?php

namespace Drupal\migrate\Plugin;

use Drupal\Component\Plugin\Attribute\AttributeInterface;
use Drupal\Component\Plugin\Attribute\PluginID;
use Drupal\Component\Plugin\Factory\DefaultFactory;
use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Plugin\DefaultPluginManager;

/**
 * Manages migrate plugins.
 *
 * @see hook_migrate_info_alter()
 * @see \Drupal\migrate\Attribute\MigrateSource
 * @see \Drupal\migrate\Plugin\MigrateSourceInterface
 * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
 * @see \Drupal\migrate\Attribute\MigrateProcess
 * @see \Drupal\migrate\Plugin\MigrateProcessInterface
 * @see \Drupal\migrate\Plugin\migrate\process\ProcessPluginBase
 * @see plugin_api
 *
 * @ingroup migration
 */
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;
    }

}

Classes

Title Deprecated Summary
MigratePluginManager Manages migrate plugins.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.