Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. ConvertTokens.php

class ConvertTokens

Plugin to replace !tokens with [tokens].

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\user\Plugin\migrate\process\ConvertTokens extends \Drupal\migrate\ProcessPluginBase

Expanded class hierarchy of ConvertTokens

File

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

Namespace

Drupal\user\Plugin\migrate\process
View source
class ConvertTokens extends ProcessPluginBase {
    
    /**
     * {@inheritdoc}
     */
    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.');
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConvertTokens::transform public function Performs the associated process. Overrides ProcessPluginBase::transform
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 5
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
ProcessPluginBase::$stopPipeline protected property Determines if processing of the pipeline is stopped.
ProcessPluginBase::isPipelineStopped public function Determines if the pipeline should stop processing. Overrides MigrateProcessInterface::isPipelineStopped
ProcessPluginBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple 3
ProcessPluginBase::reset public function Resets the internal data of a plugin. Overrides MigrateProcessInterface::reset
ProcessPluginBase::stopPipeline protected function Stops pipeline processing after this plugin finishes.

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal