public function Extract::transform in Drupal 10

Same name and namespace in other branches

1. 8 core/modules/migrate/src/Plugin/migrate/process/Extract.php \Drupal\migrate\Plugin\migrate\process\Extract::transform()
2. 9 core/modules/migrate/src/Plugin/migrate/process/Extract.php \Drupal\migrate\Plugin\migrate\process\Extract::transform()

Performs the associated process.

Parameters

mixed $value: The value to be transformed.

\Drupal\migrate\MigrateExecutableInterface $migrate_executable: The migration in which this process is being executed.

\Drupal\migrate\Row $row: The row from the source to process. Normally, just transforming the value is adequate but very rarely you might need to change two columns at the same time or something like that.

string $destination_property: The destination property currently worked on. This is only used together with the $row above.

Return value

mixed The newly transformed value.

Overrides ProcessPluginBase::transform

File

core/modules/migrate/src/Plugin/migrate/process/Extract.php, line 70

Class

Extract

Extracts a value from an array.

Namespace

Drupal\migrate\Plugin\migrate\process

Code

public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
  if (!is_array($value)) {
    throw new MigrateException(sprintf("Input should be an array, instead it was of type '%s'", gettype($value)));
  }
  $new_value = NestedArray::getValue($value, $this->configuration['index'], $key_exists);
  if (!$key_exists) {
    if (array_key_exists('default', $this->configuration)) {
      $new_value = $this->configuration['default'];
    }
    else {
      throw new MigrateException(sprintf("Array index missing, extraction failed for '%s'. Consider adding a `default` key to the configuration.", Variable::export($value)));
    }
  }
  return $new_value;
}