You are here

class PathSetTranslated in Drupal 8

Same name and namespace in other branches
  1. 9 core/modules/path/src/Plugin/migrate/process/PathSetTranslated.php \Drupal\path\Plugin\migrate\process\PathSetTranslated
  2. 10 core/modules/path/src/Plugin/migrate/process/PathSetTranslated.php \Drupal\path\Plugin\migrate\process\PathSetTranslated

A process plugin to update the path of a translated node.

Available configuration keys:

  • source: An array of two values, the first being the original path, and the second being an array of the format [nid, langcode] if a translated node exists (likely from a migration lookup). Paths not of the format '/node/<nid>' will pass through unchanged, as will any inputs with invalid or missing translated nodes.

This plugin will return the correct path for the translated node if the above conditions are met, and will return the original path otherwise.

Example: node_translation: - plugin: explode source: source delimiter: / - # If the source path has no slashes return a dummy default value. plugin: extract default: 'INVALID_NID' index:

  • 1

- plugin: migration_lookup migration: d7_node_translation _path: plugin: concat source:

  • constants/slash
  • source

path: plugin: path_set_translated source:

  • '@_path'
  • '@node_translation'

In the example above, if the node_translation lookup succeeds and the original path is of the format '/node/<original node nid>', then the new path will be set to '/node/<translated node nid>'

Plugin annotation


@MigrateProcessPlugin(
  id = "path_set_translated"
)

Hierarchy

Expanded class hierarchy of PathSetTranslated

1 file declares its use of PathSetTranslated
PathSetTranslatedTest.php in core/modules/path/tests/src/Unit/migrate/process/PathSetTranslatedTest.php

File

core/modules/path/src/Plugin/migrate/process/PathSetTranslated.php, line 57

Namespace

Drupal\path\Plugin\migrate\process
View source
class PathSetTranslated extends ProcessPluginBase {

  /**
   * {@inheritdoc}
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
    if (!is_array($value)) {
      throw new MigrateException("The input value should be an array.");
    }
    $path = isset($value[0]) ? $value[0] : '';
    $nid = is_array($value[1]) && isset($value[1][0]) ? $value[1][0] : FALSE;
    if (preg_match('/^\\/node\\/\\d+$/', $path) && $nid) {
      return '/node/' . $nid;
    }
    return $path;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
PathSetTranslated::transform public function Performs the associated process. Overrides ProcessPluginBase::transform
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.