You are here

Home » API reference » Drupal 9 » MigrateStubInterface.php

interface MigrateStubInterface in Drupal 9

Same name and namespace in other branches
  1. 8 core/modules/migrate/src/MigrateStubInterface.php \Drupal\migrate\MigrateStubInterface

Provides an interface for the migrate stub service.

Hierarchy

Expanded class hierarchy of MigrateStubInterface

All classes that implement MigrateStubInterface

1 file declares its use of MigrateStubInterface
MigrationLookup.php in core/modules/migrate/src/Plugin/migrate/process/MigrationLookup.php

File

core/modules/migrate/src/MigrateStubInterface.php, line 8

Namespace

Drupal\migrate
View source 
interface MigrateStubInterface {

  /**
   * Creates a stub.
   *
   * @param string $migration_id
   *   The migration to stub.
   * @param array $source_ids
   *   An array of source ids.
   * @param array $default_values
   *   (optional) An array of default values to add to the stub.
   *
   * @return array|false
   *   An array of destination ids for the new stub, keyed by destination id
   *   key, or false if the stub failed.
   */
  public function createStub($migration_id, array $source_ids, array $default_values = []);

}

Members

Namesort descending Modifiers Type Description Overrides
MigrateStubInterface::createStub public function Creates a stub. 1