annotate core/modules/migrate_drupal/src/Plugin/MigrateFieldPluginManagerInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\migrate_drupal\Plugin;
Chris@0 4
Chris@0 5 use Drupal\migrate\Plugin\MigratePluginManagerInterface;
Chris@0 6 use Drupal\migrate\Plugin\MigrationInterface;
Chris@0 7
Chris@0 8 interface MigrateFieldPluginManagerInterface extends MigratePluginManagerInterface {
Chris@0 9
Chris@0 10 /**
Chris@0 11 * Get the plugin ID from the field type.
Chris@0 12 *
Chris@0 13 * @param string $field_type
Chris@0 14 * The field type being migrated.
Chris@0 15 * @param array $configuration
Chris@0 16 * (optional) An array of configuration relevant to the plugin instance.
Chris@0 17 * @param \Drupal\migrate\Plugin\MigrationInterface|null $migration
Chris@0 18 * (optional) The current migration instance.
Chris@0 19 *
Chris@0 20 * @return string
Chris@0 21 * The ID of the plugin for the field_type if available.
Chris@0 22 *
Chris@0 23 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
Chris@0 24 * If the plugin cannot be determined, such as if the field type is invalid.
Chris@0 25 */
Chris@0 26 public function getPluginIdFromFieldType($field_type, array $configuration = [], MigrationInterface $migration = NULL);
Chris@0 27
Chris@0 28 }