public function ConvertTokens::transform in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/user/src/Plugin/migrate/process/ConvertTokens.php \Drupal\user\Plugin\migrate\process\ConvertTokens::transform()
2. 10 core/modules/user/src/Plugin/migrate/process/ConvertTokens.php \Drupal\user\Plugin\migrate\process\ConvertTokens::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

string|array The newly transformed value.

Overrides ProcessPluginBase::transform

File

core/modules/user/src/Plugin/migrate/process/ConvertTokens.php, line 23

Class

ConvertTokens

Plugin to replace !tokens with [tokens].

Namespace

Drupal\user\Plugin\migrate\process

Code

public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
  $tokens = [
    '!site' => '[site:name]',
    '!username' => '[user:name]',
    '!mailto' => '[user:mail]',
    '!login_uri' => '[site:login-url]',
    '!uri_brief' => '[site:url-brief]',
    '!edit_uri' => '[user:edit-url]',
    '!login_url' => '[user:one-time-login-url]',
    '!uri' => '[site:url]',
    '!date' => '[date:medium]',
    '!password' => '',
  ];

  // Given that our source is a database column that could hold a NULL
  // value, sometimes that filters down to here. str_replace() cannot
  // handle NULLs as the subject, so we reset to an empty string.
  if (is_null($value)) {
    $value = '';
  }
  if (is_string($value)) {
    return str_replace(array_keys($tokens), $tokens, $value);
  }
  else {
    throw new MigrateException('Value must be a string.');
  }
}