interface MigrateLookupInterface
Same name in other branches
- 9 core/modules/migrate/src/MigrateLookupInterface.php \Drupal\migrate\MigrateLookupInterface
- 8.9.x core/modules/migrate/src/MigrateLookupInterface.php \Drupal\migrate\MigrateLookupInterface
- 11.x core/modules/migrate/src/MigrateLookupInterface.php \Drupal\migrate\MigrateLookupInterface
Provides an interface for the migration lookup service.
@package Drupal\migrate
Hierarchy
- interface \Drupal\migrate\MigrateLookupInterface
Expanded class hierarchy of MigrateLookupInterface
All classes that implement MigrateLookupInterface
12 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 - FieldBundle.php in core/
modules/ field/ src/ Plugin/ migrate/ process/ d7/ FieldBundle.php - FieldFile.php in core/
modules/ file/ src/ Plugin/ migrate/ process/ d6/ FieldFile.php
File
-
core/
modules/ migrate/ src/ MigrateLookupInterface.php, line 10
Namespace
Drupal\migrateView 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
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
MigrateLookupInterface::lookup | public | function | Retrieves destination ids from a migration lookup. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.