interface MigrateStubInterface

Same name and namespace in other branches
  1. 9 core/modules/migrate/src/MigrateStubInterface.php \Drupal\migrate\MigrateStubInterface
  2. 8.9.x core/modules/migrate/src/MigrateStubInterface.php \Drupal\migrate\MigrateStubInterface
  3. 10 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

Title Modifiers Object type Summary
MigrateStubInterface::createStub public function Creates a stub.

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