class ProcessField

Same name and namespace in other branches
  1. 9 core/modules/field/src/Plugin/migrate/process/ProcessField.php \Drupal\field\Plugin\migrate\process\ProcessField
  2. 8.9.x core/modules/field/src/Plugin/migrate/process/ProcessField.php \Drupal\field\Plugin\migrate\process\ProcessField
  3. 11.x core/modules/field/src/Plugin/migrate/process/ProcessField.php \Drupal\field\Plugin\migrate\process\ProcessField

Get the value from a method call on a field plugin instance.

This process plugin will instantiate a field plugin based on the given field type and then call the given method on it for the return value.

Available configuration keys:

  • source: The source field type to use to instantiate a field plugin.
  • method: The method to be called on the field plugin instance.

If no field plugin for the given field type is found, NULL will be returned.

Example:


process:
  type:
    plugin: process_field
    source: type
    method: getFieldType

Hierarchy

Expanded class hierarchy of ProcessField

See also

\Drupal\migrate\Plugin\MigrateProcessInterface

\Drupal\migrate_drupal\Plugin\MigrateFieldInterface;

1 file declares its use of ProcessField
ProcessFieldTest.php in core/modules/field/tests/src/Unit/Plugin/migrate/process/ProcessFieldTest.php

File

core/modules/field/src/Plugin/migrate/process/ProcessField.php, line 41

Namespace

Drupal\field\Plugin\migrate\process
View source
class ProcessField extends ProcessPluginBase implements ContainerFactoryPluginInterface {
  
  /**
   * The field plugin manager.
   *
   * @var \Drupal\migrate_drupal\Plugin\MigrateFieldPluginManagerInterface
   */
  protected $fieldPluginManager;
  
  /**
   * The migration being run.
   *
   * @var \Drupal\migrate\Plugin\MigrationInterface
   */
  protected $migration;
  
  /**
   * Constructs a ProcessField plugin.
   *
   * @param array $configuration
   *   The plugin configuration.
   * @param string $plugin_id
   *   The plugin ID.
   * @param mixed $plugin_definition
   *   The plugin definition.
   * @param \Drupal\migrate_drupal\Plugin\MigrateFieldPluginManagerInterface $field_plugin_manager
   *   The field plugin manager.
   * @param \Drupal\migrate\Plugin\MigrationInterface $migration
   *   The migration being run.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrateFieldPluginManagerInterface $field_plugin_manager, ?MigrationInterface $migration = NULL) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->fieldPluginManager = $field_plugin_manager;
    $this->migration = $migration;
  }
  
  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, ?MigrationInterface $migration = NULL) {
    return new static($configuration, $plugin_id, $plugin_definition, $container->get('plugin.manager.migrate.field'), $migration);
  }
  
  /**
   * {@inheritdoc}
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
    if (!is_string($value)) {
      throw new MigrateException('The input value must be a string.');
    }
    if (empty($this->configuration['method'])) {
      throw new MigrateException('You need to specify the name of a method to be called on the Field plugin.');
    }
    $method = $this->configuration['method'];
    try {
      return $this->callMethodOnFieldPlugin($this->fieldPluginManager, $value, $method, $row);
    } catch (PluginNotFoundException $e) {
      return NULL;
    }
  }
  
  /**
   * Instantiate a field plugin and call a method on it.
   *
   * @param \Drupal\migrate_drupal\Plugin\MigrateFieldPluginManagerInterface $field_plugin_manager
   *   The field plugin manager.
   * @param string $field_type
   *   The field type for which to get the field plugin.
   * @param string $method
   *   The method to call on the field plugin.
   * @param \Drupal\migrate\Row $row
   *   The row from the source to process.
   *
   * @return mixed
   *   The return value from the method called on the field plugin.
   */
  protected function callMethodOnFieldPlugin(MigrateFieldPluginManagerInterface $field_plugin_manager, $field_type, $method, Row $row) {
    $plugin_id = $field_plugin_manager->getPluginIdFromFieldType($field_type, [], $this->migration);
    $plugin_instance = $field_plugin_manager->createInstance($plugin_id, [], $this->migration);
    if (!is_callable([
      $plugin_instance,
      $method,
    ])) {
      throw new MigrateException('The specified method does not exist or is not callable.');
    }
    return call_user_func_array([
      $plugin_instance,
      $method,
    ], [
      $row,
    ]);
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
ProcessField::$fieldPluginManager protected property The field plugin manager.
ProcessField::$migration protected property The migration being run.
ProcessField::callMethodOnFieldPlugin protected function Instantiate a field plugin and call a method on it.
ProcessField::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ProcessField::transform public function Performs the associated process. Overrides ProcessPluginBase::transform
ProcessField::__construct public function Constructs a ProcessField plugin.
ProcessPluginBase::$stopPipeline protected property Determines if processing of the pipeline is stopped.
ProcessPluginBase::isPipelineStopped public function Determines if the pipeline should stop processing. Overrides MigrateProcessInterface::isPipelineStopped
ProcessPluginBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple 3
ProcessPluginBase::reset public function Resets the internal data of a plugin. Overrides MigrateProcessInterface::reset
ProcessPluginBase::stopPipeline protected function Stops pipeline processing after this plugin finishes.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.