abstract class ProcessPluginBase in Zircon Profile 8.0

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.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
    • class \Drupal\migrate\ProcessPluginBase implements MigrateProcessInterface

See also

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

\Drupal\migrate\Plugin\MigratePluginManager

\Drupal\migrate\Plugin\MigrateProcessInterface

\Drupal\migrate\Annotation\MigrateProcessPlugin

Plugin API

Related topics

Migration API

Overview of the Migration API, which migrates data into Drupal.

45 files declare their use of ProcessPluginBase

BlockPluginId.php in core/modules/block/src/Plugin/migrate/process/BlockPluginId.php

Contains \Drupal\block\Plugin\migrate\process\BlockPluginId.

BlockRegion.php in core/modules/block/src/Plugin/migrate/process/BlockRegion.php

Contains \Drupal\block\Plugin\migrate\process\BlockRegion.

BlockSettings.php in core/modules/block/src/Plugin/migrate/process/BlockSettings.php

Contains \Drupal\block\Plugin\migrate\process\BlockSettings.

BlockTheme.php in core/modules/block/src/Plugin/migrate/process/BlockTheme.php

Contains \Drupal\block\Plugin\migrate\process\BlockTheme.

BlockVisibility.php in core/modules/block/src/Plugin/migrate/process/BlockVisibility.php

Contains \Drupal\block\Plugin\migrate\process\BlockVisibility.

... See full list

File

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

Contains \Drupal\migrate\ProcessPluginBase.

Namespace

Drupal\migrate

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

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	2
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
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
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::__construct	public	function	Constructs a Drupal\Component\Plugin\PluginBase object.	69
ProcessPluginBase::multiple	public	function	Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple	2
ProcessPluginBase::transform	public	function	Performs the associated process. Overrides MigrateProcessInterface::transform	44
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.
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.