You are here

class LinkUri in Drupal 10

Same name and namespace in other branches
  1. 8 core/modules/menu_link_content/src/Plugin/migrate/process/LinkUri.php \Drupal\menu_link_content\Plugin\migrate\process\LinkUri
  2. 9 core/modules/menu_link_content/src/Plugin/migrate/process/LinkUri.php \Drupal\menu_link_content\Plugin\migrate\process\LinkUri

Generates an internal URI from the source value.

Converts the source path value to an 'entity:', 'internal:' or 'base:' URI.

Available configuration keys:

  • source: A source path to be converted into an URI.
  • validate_route: (optional) Whether the plugin should validate that the URI derived from the source link path has a valid Drupal route.

    • TRUE: Throw a MigrateException if the resulting URI is not routed. This value is the default.
    • FALSE: Return the URI for the unrouted path.

Examples:


process:
  link/uri:
    plugin: link_uri
    validate_route: false
    source: link_path

This will set the uri property of link to the internal notation of link_path without validating if the resulting URI is valid. For example, if the 'link_path' property is 'node/12', the uri property value of link will be 'entity:node/12'.

Plugin annotation


@MigrateProcessPlugin(
  id = "link_uri"
)

Hierarchy

Expanded class hierarchy of LinkUri

1 file declares its use of LinkUri
LinkUriTest.php in core/modules/menu_link_content/tests/src/Kernel/Plugin/migrate/process/LinkUriTest.php

File

core/modules/menu_link_content/src/Plugin/migrate/process/LinkUri.php, line 46

Namespace

Drupal\menu_link_content\Plugin\migrate\process
View source
class LinkUri extends ProcessPluginBase implements ContainerFactoryPluginInterface {

  /**
   * The entity type manager, used to fetch entity link templates.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a LinkUri object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager, used to fetch entity link templates.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager) {
    $configuration += [
      'validate_route' => TRUE,
    ];
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
    $path = ltrim($value, '/');
    if (parse_url($path, PHP_URL_SCHEME) === NULL) {
      if ($path == '<front>') {
        $path = '';
      }
      elseif ($path == '<nolink>') {
        return 'route:<nolink>';
      }
      $path = 'internal:/' . $path;

      // Convert entity URIs to the entity scheme, if the path matches a route
      // of the form "entity.$entity_type_id.canonical".
      // @see \Drupal\Core\Url::fromEntityUri()
      $url = Url::fromUri($path);
      if ($url
        ->isRouted()) {
        $route_name = $url
          ->getRouteName();
        foreach (array_keys($this->entityTypeManager
          ->getDefinitions()) as $entity_type_id) {
          if ($route_name == "entity.{$entity_type_id}.canonical" && isset($url
            ->getRouteParameters()[$entity_type_id])) {
            return "entity:{$entity_type_id}/" . $url
              ->getRouteParameters()[$entity_type_id];
          }
        }
      }
      else {

        // If the URL is not routed, we might want to get something back to do
        // other processing. If this is the case, the "validate_route"
        // configuration option can be set to FALSE to return the URI.
        if (!$this->configuration['validate_route']) {
          return $url
            ->getUri();
        }
        else {
          throw new MigrateException(sprintf('The path "%s" failed validation.', $path));
        }
      }
    }
    return $path;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
LinkUri::$entityTypeManager protected property The entity type manager, used to fetch entity link templates.
LinkUri::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
LinkUri::transform public function Performs the associated process. Overrides ProcessPluginBase::transform
LinkUri::__construct public function Constructs a LinkUri object. Overrides PluginBase::__construct
MessengerTrait::$messenger protected property The messenger. 18
MessengerTrait::messenger public function Gets the messenger. 18
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.
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
PluginBase::getDerivativeId public function
PluginBase::getPluginDefinition public function 2
PluginBase::getPluginId public function
PluginBase::isConfigurable public function Determines if the plugin is configurable.
ProcessPluginBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple 3
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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. 1
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.