class LinkUri
Same name in this branch
- 11.x core/modules/menu_link_content/src/Plugin/migrate/process/LinkUri.php \Drupal\menu_link_content\Plugin\migrate\process\LinkUri
Same name and namespace in other branches
- 8.9.x core/modules/menu_link_content/src/Plugin/migrate/process/d6/LinkUri.php \Drupal\menu_link_content\Plugin\migrate\process\d6\LinkUri
- 10 core/modules/menu_link_content/src/Plugin/migrate/process/LinkUri.php \Drupal\menu_link_content\Plugin\migrate\process\LinkUri
- 9 core/modules/menu_link_content/src/Plugin/migrate/process/LinkUri.php \Drupal\menu_link_content\Plugin\migrate\process\LinkUri
- 8.9.x core/modules/menu_link_content/src/Plugin/migrate/process/LinkUri.php \Drupal\menu_link_content\Plugin\migrate\process\LinkUri
- main core/modules/menu_link_content/src/Plugin/migrate/process/LinkUri.php \Drupal\menu_link_content\Plugin\migrate\process\LinkUri
- main core/modules/migrate/src/Plugin/migrate/process/LinkUri.php \Drupal\migrate\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'.
Attributes
#[MigrateProcess('link_uri')]
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
- class \Drupal\migrate\ProcessPluginBase implements \Drupal\migrate\Plugin\MigrateProcessInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\migrate\Plugin\migrate\process\LinkUri implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface extends \Drupal\migrate\ProcessPluginBase
- class \Drupal\migrate\ProcessPluginBase implements \Drupal\migrate\Plugin\MigrateProcessInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of LinkUri
1 file declares its use of LinkUri
- LinkUriTest.php in core/
modules/ migrate/ tests/ src/ Kernel/ process/ LinkUriTest.php
File
-
core/
modules/ migrate/ src/ Plugin/ migrate/ process/ LinkUri.php, line 42
Namespace
Drupal\migrate\Plugin\migrate\processView source
class LinkUri extends ProcessPluginBase implements ContainerFactoryPluginInterface {
public function __construct(array $configuration, $plugin_id, $plugin_definition, protected EntityTypeManagerInterface $entityTypeManager) {
$configuration += [
'validate_route' => TRUE,
];
parent::__construct($configuration, $plugin_id, $plugin_definition);
}
/**
* {@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 (empty($path) || in_array($path, [
'<nolink>',
'<none>',
], TRUE)) {
return 'route:<nolink>';
}
elseif ($path === '<button>') {
return 'route:<button>';
}
$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()) {
if (preg_match('/^entity\\.(.*)\\.canonical$/', $url->getRouteName(), $matches)) {
$entity_type_id = $matches[1];
if (isset($url->getRouteParameters()[$entity_type_id], $this->entityTypeManager
->getDefinitions()[$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']) {
throw new MigrateException(sprintf('The path "%s" failed validation.', $path));
}
return $url->getUri();
}
}
return $path;
}
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.