interface MigratePluginManagerInterface

Same name and namespace in other branches
  1. 9 core/modules/migrate/src/Plugin/MigratePluginManagerInterface.php \Drupal\migrate\Plugin\MigratePluginManagerInterface
  2. 8.9.x core/modules/migrate/src/Plugin/MigratePluginManagerInterface.php \Drupal\migrate\Plugin\MigratePluginManagerInterface
  3. 10 core/modules/migrate/src/Plugin/MigratePluginManagerInterface.php \Drupal\migrate\Plugin\MigratePluginManagerInterface

Interface for the migration plugin manager.

Hierarchy

Expanded class hierarchy of MigratePluginManagerInterface

All classes that implement MigratePluginManagerInterface

2 files declare their use of MigratePluginManagerInterface
MigrateFieldPluginManagerInterface.php in core/modules/migrate_drupal/src/Plugin/MigrateFieldPluginManagerInterface.php
MigrateProcessErrorMessagesTest.php in core/modules/migrate/tests/src/Kernel/MigrateProcessErrorMessagesTest.php

File

core/modules/migrate/src/Plugin/MigratePluginManagerInterface.php, line 10

Namespace

Drupal\migrate\Plugin
View on git.drupalcode.org
View source 
interface MigratePluginManagerInterface extends PluginManagerInterface {
  
  /**
   * Creates a pre-configured instance of a migration plugin.
   *
   * A specific createInstance method is necessary to pass the migration on.
   *
   * @param string $plugin_id
   *   The ID of the plugin being instantiated.
   * @param array $configuration
   *   An array of configuration relevant to the plugin instance.
   * @param \Drupal\migrate\Plugin\MigrationInterface $migration
   *   The migration context in which the plugin will run.
   *
   * @return object
   *   A fully configured plugin instance.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   *   If the instance cannot be created, such as if the ID is invalid.
   */
  public function createInstance($plugin_id, array $configuration = [], ?MigrationInterface $migration = NULL);

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
DiscoveryInterface::getDefinition public function Gets a specific plugin definition. 4
DiscoveryInterface::getDefinitions public function Gets the definition of all plugins for this type. 3
DiscoveryInterface::hasDefinition public function Indicates if a specific plugin definition exists. 1
MapperInterface::getInstance public function Gets or creates a plugin instance that satisfies the given options. 3
MigratePluginManagerInterface::createInstance public function Creates a pre-configured instance of a migration plugin. Overrides FactoryInterface::createInstance

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