You are here

abstract class ProcessPluginBase in Drupal 9

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

The base class for all migrate process plugins.

Migrate process plugins are taking a value and transform them. For example, transform a human provided name into a machine name, look up an identifier in a previous migration and so on.

Process plugins extending this class can use any number of methods, thus offering different alternative ways of processing. In this case, the transform() method should not be implemented, and the plugin configuration must provide the name of the method to be called via the "method" key. Each method must have the same signature as transform().

Hierarchy

Expanded class hierarchy of ProcessPluginBase

See also

https://www.drupal.org/node/2129651

\Drupal\migrate\Plugin\MigratePluginManager

\Drupal\migrate\Plugin\MigrateProcessInterface

\Drupal\migrate\Annotation\MigrateProcessPlugin

\Drupal\migrate\Plugin\migrate\process\SkipOnEmpty

d7_field_formatter_settings.yml

Plugin API

Related topics

72 files declare their use of ProcessPluginBase
ArrayBuild.php in core/modules/migrate/src/Plugin/migrate/process/ArrayBuild.php
BlockPluginId.php in core/modules/block/src/Plugin/migrate/process/BlockPluginId.php
BlockSettings.php in core/modules/block/src/Plugin/migrate/process/BlockSettings.php
BlockTheme.php in core/modules/block/src/Plugin/migrate/process/BlockTheme.php
BlockVisibility.php in core/modules/block/src/Plugin/migrate/process/BlockVisibility.php

... See full list

File

core/modules/migrate/src/ProcessPluginBase.php, line 31

Namespace

Drupal\migrate
View source
abstract class ProcessPluginBase extends PluginBase implements MigrateProcessInterface {

  /**
   * {@inheritdoc}
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {

    // Do not call this method from children.
    if (isset($this->configuration['method'])) {
      if (method_exists($this, $this->configuration['method'])) {
        return $this
          ->{$this->configuration['method']}($value, $migrate_executable, $row, $destination_property);
      }
      throw new \BadMethodCallException(sprintf('The %s method does not exist in the %s plugin.', $this->configuration['method'], $this->pluginId));
    }
    else {
      throw new \BadMethodCallException(sprintf('The "method" key in the plugin configuration must to be set for the %s plugin.', $this->pluginId));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function multiple() {
    return FALSE;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 98
ProcessPluginBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple 3
ProcessPluginBase::transform public function Performs the associated process. Overrides MigrateProcessInterface::transform 72
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.