interface MigrationPluginManagerInterface

Migration plugin manager interface.

Hierarchy

Expanded class hierarchy of MigrationPluginManagerInterface

All classes that implement MigrationPluginManagerInterface

18 files declare their use of MigrationPluginManagerInterface
CredentialForm.php in core/modules/migrate_drupal_ui/src/Form/CredentialForm.php
FieldDiscovery.php in core/modules/migrate_drupal/src/FieldDiscovery.php
FieldDiscoveryTest.php in core/modules/migrate_drupal/tests/src/Unit/FieldDiscoveryTest.php
FieldDiscoveryTestClass.php in core/modules/migrate_drupal/tests/modules/field_discovery_test/src/FieldDiscoveryTestClass.php
FieldDiscoveryTestTrait.php in core/modules/migrate_drupal/tests/src/Traits/FieldDiscoveryTestTrait.php

... See full list

File

View on git.drupalcode.org

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

Namespace

Drupal\migrate\Plugin
View source 
interface MigrationPluginManagerInterface extends PluginManagerInterface {
  
  /**
   * Create pre-configured instance of plugin derivatives.
   *
   * @param array $id
   *   Either the plugin ID or the base plugin ID of the plugins being
   *   instantiated. Also accepts an array of plugin IDs and an empty array to
   *   load all plugins.
   * @param array $configuration
   *   An array of configuration relevant to the plugin instances. Keyed by the
   *   plugin ID.
   *
   * @return \Drupal\migrate\Plugin\MigrationInterface[]
   *   Fully configured plugin instances.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   *   If an instance cannot be created, such as if the ID is invalid.
   */
  public function createInstances($id, array $configuration = []);
  
  /**
   * Expand derivative migration dependencies.
   *
   * @param string[] $migration_ids
   *   A list of plugin IDs.
   *
   * @return array
   *   An array of expanded plugin ids.
   */
  public function expandPluginIds(array $migration_ids);
  
  /**
   * Creates a stub migration plugin from a definition array.
   *
   * @param array $definition
   *   The migration definition. If an 'id' key is set then this will be used as
   *   the migration ID, if not a random ID will be assigned.
   *
   * @return \Drupal\migrate\Plugin\Migration
   *   The stub migration.
   */
  public function createStubMigration(array $definition);
  
  /**
   * Create migrations given a tag.
   *
   * @param string $tag
   *   A migration tag we want to filter by.
   *
   * @return array|\Drupal\migrate\Plugin\MigrationInterface[]
   *   An array of migration objects with the given tag, or an empty array if no
   *   migrations with that tag exist.
   */
  public function createInstancesByTag($tag);

}

Members

Title Modifiers Object type Summary 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
FactoryInterface::createInstance public function Creates a plugin instance based on the provided ID and configuration. 6
MapperInterface::getInstance public function Gets or creates a plugin instance that satisfies the given options. 3
MigrationPluginManagerInterface::createInstances public function Create pre-configured instance of plugin derivatives. 1
MigrationPluginManagerInterface::createInstancesByTag public function Create migrations given a tag. 1
MigrationPluginManagerInterface::createStubMigration public function Creates a stub migration plugin from a definition array. 1
MigrationPluginManagerInterface::expandPluginIds public function Expand derivative migration dependencies. 1

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