class Substr

Returns a substring of the input value.

The substr process plugin returns the portion of the input value specified by the start and length parameters. This is a wrapper around mb_substr().

Available configuration keys:

• start: (optional) The returned string will start this many characters after the beginning of the string, defaults to 0.
• length: (optional) The maximum number of characters in the returned string, defaults to NULL.

If start is 0 and length is an integer, the start position is the beginning of the string. If start is an integer and length is NULL, the substring starting from the start position until the end of the string will be returned. If start is 0 and length is NULL the entire string is returned.

Example:

process:
  new_text_field:
    plugin: substr
    source: some_text_field
    start: 6
    length: 10

If some_text_field was 'Marie Skłodowska Curie' then $destination['new_text_field'] would be 'Skłodowska'.

The PHP equivalent of this is:

$destination['new_text_field'] = substr($source['some_text_field'], 6, 10);

The substr plugin requires that the source value is not empty. If empty values are expected, combine skip_on_empty process plugin to the pipeline:

process:
  new_text_field:
   -
     plugin: skip_on_empty
     method: process
     source: some_text_field
   -
     plugin: substr
     start: 6
     length: 10

Plugin annotation

@MigrateProcessPlugin(
  id = "substr"
)

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\Substr extends \Drupal\migrate\ProcessPluginBase

Expanded class hierarchy of Substr

See also

\Drupal\migrate\Plugin\MigrateProcessInterface

File

core/modules/migrate/src/Plugin/migrate/process/Substr.php, line 68

Namespace

class Substr extends ProcessPluginBase {
    
    /**
     * {@inheritdoc}
     */
    public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
        $start = $this->configuration['start'] ?? 0;
        if (!is_int($start)) {
            throw new MigrateException('The start position configuration value should be an integer. Omit this key to capture from the beginning of the string.');
        }
        $length = $this->configuration['length'] ?? NULL;
        if ($length !== NULL && !is_int($length)) {
            throw new MigrateException('The character length configuration value should be an integer. Omit this key to capture from the start position to the end of the string.');
        }
        if (!is_string($value)) {
            throw new MigrateException('The input value must be a string.');
        }
        // Use optional start or length to return a portion of $value.
        return mb_substr($value, $start, $length);
    }

}

Members