aleph1.co.uk Git - yaffs-website/blob - web/core/modules/migrate/src/Plugin/MigratePluginManagerInterface.php

   1 <?php
   2
   3 namespace Drupal\migrate\Plugin;
   4
   5 use Drupal\Component\Plugin\PluginManagerInterface;
   6
   7 interface MigratePluginManagerInterface extends PluginManagerInterface {
   8
   9   /**
  10    * Creates a pre-configured instance of a migration plugin.
  11    *
  12    * A specific createInstance method is necessary to pass the migration on.
  13    *
  14    * @param string $plugin_id
  15    *   The ID of the plugin being instantiated.
  16    * @param array $configuration
  17    *   An array of configuration relevant to the plugin instance.
  18    * @param \Drupal\migrate\Plugin\MigrationInterface $migration
  19    *   The migration context in which the plugin will run.
  20    *
  21    * @return object
  22    *   A fully configured plugin instance.
  23    *
  24    * @throws \Drupal\Component\Plugin\Exception\PluginException
  25    *   If the instance cannot be created, such as if the ID is invalid.
  26    */
  27   public function createInstance($plugin_id, array $configuration = [], MigrationInterface $migration = NULL);
  28
  29 }