class Concat

Concatenates a set of strings.

The concat plugin is used to concatenate strings. For example, imploding a set of strings into a single string.

Available configuration keys:

• delimiter: (optional) A delimiter, or glue string, to insert between the strings.

Examples:

process:
  new_text_field:
    plugin: concat
    source:
      - foo
      - bar

This will set new_text_field to the concatenation of the 'foo' and 'bar' source values. For example, if the 'foo' property is "Rosa" and the 'bar' property is "Parks", new_text_field will be "RosaParks".

You can also specify a delimiter.

process:
  new_text_field:
    plugin: concat
    source:
      - foo
      - bar
    delimiter: /

This will set new_text_field to the concatenation of the 'foo' source value, the delimiter and the 'bar' source value. For example, using the values above and "/" as the delimiter, if the 'foo' property is "Rosa" and the 'bar' property is "Rosa", new_text_field will be "Rosa/Parks".

Plugin annotation

@MigrateProcessPlugin(
  id = "concat",
  handle_multiples = TRUE
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
    • class \Drupal\migrate\ProcessPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\migrate\Plugin\MigrateProcessInterface
      • class \Drupal\migrate\Plugin\migrate\process\Concat extends \Drupal\migrate\ProcessPluginBase

Expanded class hierarchy of Concat

See also

\Drupal\migrate\Plugin\MigrateProcessInterface

File

core/modules/migrate/src/Plugin/migrate/process/Concat.php, line 59

Namespace

class Concat extends ProcessPluginBase {
    
    /**
     * {@inheritdoc}
     */
    public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
        if (is_array($value)) {
            $delimiter = $this->configuration['delimiter'] ?? '';
            return implode($delimiter, $value);
        }
        else {
            throw new MigrateException(sprintf('%s is not an array', var_export($value, TRUE)));
        }
    }

}

Members