Mercurial > hg > isophonics-drupal-site
annotate core/modules/migrate/src/Plugin/MigratePluginManagerInterface.php @ 19:fa3358dc1485 tip
Add ndrum files
author | Chris Cannam |
---|---|
date | Wed, 28 Aug 2019 13:14:47 +0100 |
parents | 4c8ae668cc8c |
children |
rev | line source |
---|---|
Chris@0 | 1 <?php |
Chris@0 | 2 |
Chris@0 | 3 namespace Drupal\migrate\Plugin; |
Chris@0 | 4 |
Chris@0 | 5 use Drupal\Component\Plugin\PluginManagerInterface; |
Chris@0 | 6 |
Chris@0 | 7 interface MigratePluginManagerInterface extends PluginManagerInterface { |
Chris@0 | 8 |
Chris@0 | 9 /** |
Chris@0 | 10 * Creates a pre-configured instance of a migration plugin. |
Chris@0 | 11 * |
Chris@0 | 12 * A specific createInstance method is necessary to pass the migration on. |
Chris@0 | 13 * |
Chris@0 | 14 * @param string $plugin_id |
Chris@0 | 15 * The ID of the plugin being instantiated. |
Chris@0 | 16 * @param array $configuration |
Chris@0 | 17 * An array of configuration relevant to the plugin instance. |
Chris@0 | 18 * @param \Drupal\migrate\Plugin\MigrationInterface $migration |
Chris@0 | 19 * The migration context in which the plugin will run. |
Chris@0 | 20 * |
Chris@0 | 21 * @return object |
Chris@0 | 22 * A fully configured plugin instance. |
Chris@0 | 23 * |
Chris@0 | 24 * @throws \Drupal\Component\Plugin\Exception\PluginException |
Chris@0 | 25 * If the instance cannot be created, such as if the ID is invalid. |
Chris@0 | 26 */ |
Chris@0 | 27 public function createInstance($plugin_id, array $configuration = [], MigrationInterface $migration = NULL); |
Chris@0 | 28 |
Chris@0 | 29 } |