Drupal 8.0.0 beta 12. More info: https://www.drupal.org/node/2514176

core/modules/migrate/src/Plugin/MigrateDestinationInterface.php

@@ -0,0 +1,109 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\migrate\Plugin\MigrateDestinationInterface.
+ */
+
+namespace Drupal\migrate\Plugin;
+
+use Drupal\Component\Plugin\PluginInspectionInterface;
+use Drupal\migrate\Entity\MigrationInterface;
+use Drupal\migrate\Row;
+
+/**
+ * Destinations are responsible for persisting source data into the destination
+ * Drupal.
+ *
+ * @see \Drupal\migrate\Plugin\destination\DestinationBase
+ * @see \Drupal\migrate\Plugin\MigrateDestinationPluginManager
+ * @see \Drupal\migrate\Annotation\MigrateDestination
+ * @see plugin_api
+ *
+ * @ingroup migration
+ */
+interface MigrateDestinationInterface extends PluginInspectionInterface {
+
+  /**
+   * Get the destination ids.
+   *
+   * To support MigrateIdMap maps, derived destination classes should return
+   * schema field definition(s) corresponding to the primary key of the
+   * destination being implemented. These are used to construct the destination
+   * key fields of the map table for a migration using this destination.
+   *
+   * @return array
+   *   An array of ids.
+   */
+  public function getIds();
+
+  /**
+   * Returns an array of destination fields.
+   *
+   * Derived classes must implement fields(), returning a list of available
+   * destination fields.
+   *
+   * @todo Review the cases where we need the Migration parameter,
+   * can we avoid that?
+   *
+   * @param \Drupal\migrate\Entity\MigrationInterface $migration
+   *   (optional) the migration containing this destination.
+   *
+   * @return array
+   *   - Keys: machine names of the fields
+   *   - Values: Human-friendly descriptions of the fields.
+   */
+  public function fields(MigrationInterface $migration = NULL);
+
+
+  /**
+   * Allows pre-processing of an import.
+   *
+   * Derived classes may implement preImport() to do any processing they need
+   * done before over all source rows.
+   */
+  public function preImport();
+
+  /**
+   * Allows pre-processing of a rollback.
+   */
+  public function preRollback();
+
+  /**
+   * Allows post-processing of an import.
+   *
+   * Derived classes may implement postImport(), to do any processing they need
+   * done after looping over all source rows.
+   */
+  public function postImport();
+
+  /**
+   * Allows post-processing of a rollback.
+   */
+  public function postRollback();
+
+  /**
+   * Import the row.
+   *
+   * Derived classes must implement import(), to construct one new object
+   * (pre-populated) using ID mappings in the Migration).
+   *
+   * @param \Drupal\migrate\Row $row
+   *   The row object.
+   * @param array $old_destination_id_values
+   *   The old destination ids.
+   *
+   * @return mixed
+   *   The entity id or an indication of success.
+   */
+  public function import(Row $row, array $old_destination_id_values = array());
+
+  /**
+   * Delete the specified IDs from the target Drupal.
+   *
+   * @param array $destination_identifiers
+   *   The destination ids to delete.
+   */
+  public function rollbackMultiple(array $destination_identifiers);
+
+}