class ParagraphsProcessOnValue in Paragraphs 8

Runs a migration process on a value if a condition is met.

The process will run if a source value is equal to an expected value. Otherwise returns the original value unchanged.

Configuration Keys:

source_value: (required) string. The source property to check against. expected_value: (required) string. The value to check against. If the source property described by source_value matches this value, the process will be executed. process: (required) array. The process array to execute if the source property matches the expected value.

Plugin annotation


@MigrateProcessPlugin(
  id = "paragraphs_process_on_value"
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\migrate\ProcessPluginBase implements MigrateProcessInterface
    class \Drupal\paragraphs\Plugin\migrate\process\ProcessPluginBase implements ConfigurableInterface, ContainerFactoryPluginInterface
    class \Drupal\paragraphs\Plugin\migrate\process\ParagraphsProcessOnValue

Expanded class hierarchy of ParagraphsProcessOnValue

File

src/Plugin/migrate/process/ParagraphsProcessOnValue.php, line 29

Namespace

Drupal\paragraphs\Plugin\migrate\process

View source

class ParagraphsProcessOnValue extends ProcessPluginBase {

  /**
   * {@inheritdoc}
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
    if (empty($this->configuration['source_value'])) {
      throw new \InvalidArgumentException("Required argument 'source_value' not set for paragraphs_process_on_value plugin");
    }
    if (!isset($this->configuration['expected_value'])) {
      throw new \InvalidArgumentException("Required argument 'expected_value' not set for paragraphs_process_on_value plugin");
    }
    if (empty($this->configuration['process']) || !is_array($this->configuration['process'])) {
      throw new \InvalidArgumentException("Required argument 'process' not set or invalid for paragraphs_process_on_value plugin");
    }
    $source_value = $row
      ->getSourceProperty($this->configuration['source_value']);
    if (is_null($source_value)) {

      // This is probably a migration that shouldn't be touched by Paragraphs.
      // For example, throwing an exception here would prevent the migration of
      // the comment field configurations.
      return $value;
    }
    if ($source_value === $this->configuration['expected_value']) {
      $process = $this->configuration['process'];

      // Append the current working value to the new source we are creating.
      $source = $row
        ->getSource();
      $source['paragraphs_process_on_value_source_field'] = $value;

      // If there is a single process plugin, add the source field.  If there
      // is an array of process plugins, add the source field to the first one.
      if (array_key_exists('plugin', $process)) {
        if (empty($process['source'])) {
          $process['source'] = 'paragraphs_process_on_value_source_field';
        }
      }
      else {
        if (empty($process[0]['source'])) {
          $process[0]['source'] = 'paragraphs_process_on_value_source_field';
        }
      }
      $source = $row
        ->getSource();
      $source['paragraphs_process_on_value_source_field'] = $value;
      $new_row = new Row($source, []);
      $migrate_executable
        ->processRow($new_row, [
        $destination_property => $process,
      ]);
      return $new_row
        ->getDestinationProperty($destination_property);
    }
    else {
      return $value;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'source_value' => '',
      'expected_value' => '',
      'process' => [],
    ] + parent::defaultConfiguration();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
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
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
ParagraphsProcessOnValue::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ProcessPluginBase::defaultConfiguration
ParagraphsProcessOnValue::transform	public	function	Performs the associated process. Overrides ProcessPluginBase::transform
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	3
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.
ProcessPluginBase::$entityTypeBundleInfo	protected	property	The entity bundle info service.
ProcessPluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ProcessPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ProcessPluginBase::multiple	public	function	Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple	3
ProcessPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ProcessPluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.

You are here