You are here

class Concat in Drupal 8

Same name and namespace in other branches
  1. 9 core/modules/migrate/src/Plugin/migrate/process/Concat.php \Drupal\migrate\Plugin\migrate\process\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

Expanded class hierarchy of Concat

See also

\Drupal\migrate\Plugin\MigrateProcessInterface

2 files declare their use of Concat
ConcatTest.php in core/modules/migrate/tests/src/Unit/process/ConcatTest.php
Contains \Drupal\Tests\migrate\Unit\process\ConcatTest.
ExplodeTest.php in core/modules/migrate/tests/src/Unit/process/ExplodeTest.php

File

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

Namespace

Drupal\migrate\Plugin\migrate\process
View source
class Concat extends ProcessPluginBase {

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

}

Members

Namesort descending Modifiers Type Description Overrides
Concat::transform public function Performs the associated process. Overrides ProcessPluginBase::transform
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.
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.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
ProcessPluginBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple 3
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.