You are here

interface MigrateLookupInterface in Drupal 8

Same name and namespace in other branches
  1. 9 core/modules/migrate/src/MigrateLookupInterface.php \Drupal\migrate\MigrateLookupInterface
  2. 10 core/modules/migrate/src/MigrateLookupInterface.php \Drupal\migrate\MigrateLookupInterface

Provides an interface for the migration lookup service.

@package Drupal\migrate

Hierarchy

Expanded class hierarchy of MigrateLookupInterface

All classes that implement MigrateLookupInterface

13 files declare their use of MigrateLookupInterface
BlockPluginId.php in core/modules/block/src/Plugin/migrate/process/BlockPluginId.php
BlockVisibility.php in core/modules/block/src/Plugin/migrate/process/BlockVisibility.php
BlockVisibilityTest.php in core/modules/block/tests/src/Unit/Plugin/migrate/process/BlockVisibilityTest.php
CckFileTest.php in core/modules/file/tests/src/Unit/Plugin/migrate/process/d6/CckFileTest.php
FieldFile.php in core/modules/file/src/Plugin/migrate/process/d6/FieldFile.php

... See full list

File

core/modules/migrate/src/MigrateLookupInterface.php, line 10

Namespace

Drupal\migrate
View source
interface MigrateLookupInterface {

  /**
   * Retrieves destination ids from a migration lookup.
   *
   * @param string|string[] $migration_ids
   *   An array of migration plugin IDs to look up, or a single ID as a string.
   * @param array $source_id_values
   *   An array of source id values.
   *
   * @return array
   *   An array of arrays of destination ids, or an empty array if none were
   *   found.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   *   Thrown by the migration plugin manager on error, or if the migration(s)
   *   cannot be found.
   * @throws \Drupal\migrate\MigrateException
   *   Thrown when $source_id_values contains unknown keys, or is the wrong
   *   length.
   */
  public function lookup($migration_ids, array $source_id_values);

}

Members

Namesort descending Modifiers Type Description Overrides
MigrateLookupInterface::lookup public function Retrieves destination ids from a migration lookup. 1