You are here

Home » API reference » Zircon Profile 8 » MigrateBuilderInterface.php

interface MigrateBuilderInterface in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/migrate/src/Plugin/MigrateBuilderInterface.php \Drupal\migrate\Plugin\MigrateBuilderInterface

Defines the builder plugin type.

Builder plugins implement custom logic to generate migration entities from migration templates. For example, a migration may need to be customized based on data that's present in the source database; such customization is implemented by builders.

Hierarchy

Expanded class hierarchy of MigrateBuilderInterface

All classes that implement MigrateBuilderInterface

1 file declares its use of MigrateBuilderInterface
BuilderBase.php in core/modules/migrate/src/Plugin/migrate/builder/BuilderBase.php
Contains \Drupal\migrate\Plugin\migrate\builder\BuilderBase.

File

core/modules/migrate/src/Plugin/MigrateBuilderInterface.php, line 18
Contains \Drupal\migrate\Plugin\MigrateBuilderInterface.

Namespace

Drupal\migrate\Plugin
View source 
interface MigrateBuilderInterface {

  /**
   * Builds migration entities based on a template.
   *
   * @param array $template
   *   The parsed template.
   *
   * @return \Drupal\migrate\Entity\MigrationInterface[]
   *   The unsaved migrations generated from the template.
   */
  public function buildMigrations(array $template);

}

Members

Namesort descending Modifiers Type Description Overrides
MigrateBuilderInterface::buildMigrations public function Builds migration entities based on a template. 6