class Route
Same name in this branch
- 9 core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/Annotation/Route.php \Drupal\Tests\Component\Annotation\Doctrine\Fixtures\Annotation\Route
Same name in other branches
- 8.9.x core/modules/migrate/src/Plugin/migrate/process/Route.php \Drupal\migrate\Plugin\migrate\process\Route
- 8.9.x core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/Annotation/Route.php \Drupal\Tests\Component\Annotation\Doctrine\Fixtures\Annotation\Route
- 10 core/modules/migrate/src/Plugin/migrate/process/Route.php \Drupal\migrate\Plugin\migrate\process\Route
- 10 core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/Annotation/Route.php \Drupal\Tests\Component\Annotation\Doctrine\Fixtures\Annotation\Route
- 11.x core/modules/migrate/src/Plugin/migrate/process/Route.php \Drupal\migrate\Plugin\migrate\process\Route
- 11.x core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/Annotation/Route.php \Drupal\Tests\Component\Annotation\Doctrine\Fixtures\Annotation\Route
Sets the destination route information based on the source link_path.
The source value is an array of two values:
- link_path: The path or URL of the route.
- options: An array of URL options, e.g. query string, attributes, etc.
Example:
process:
new_route_field:
plugin: route
source:
- 'https://www.drupal.org'
-
attributes:
title: Drupal
This will set new_route_field to be a route with the URL "https://www.drupal.org" and title attribute "Drupal".
Example:
process:
another_route_field:
plugin: route
source:
- 'user/login'
-
query:
destination: 'node/1'
This will set another_route_field to be a route to the user login page (user/login) with a query string of "destination=node/1".
Plugin annotation
@MigrateProcessPlugin(
id = "route"
)
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\migrate\Plugin\migrate\process\Route extends \Drupal\migrate\ProcessPluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface
- class \Drupal\migrate\ProcessPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\migrate\Plugin\MigrateProcessInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of Route
See also
\Drupal\migrate\Plugin\MigrateProcessInterface
1 file declares its use of Route
- RouteTest.php in core/
modules/ migrate/ tests/ src/ Kernel/ process/ RouteTest.php
48 string references to 'Route'
- BlockPageVariantTest::providerBuild in core/
modules/ block/ tests/ src/ Unit/ Plugin/ DisplayVariant/ BlockPageVariantTest.php - BlockPageVariantTest::testBuild in core/
modules/ block/ tests/ src/ Unit/ Plugin/ DisplayVariant/ BlockPageVariantTest.php - Tests the building of a full page variant.
- CacheableExceptionTest::testCacheableHttpException in core/
tests/ Drupal/ Tests/ Core/ Http/ CacheableExceptionTest.php - @covers \Drupal\Core\Http\Exception\CacheableHttpException
- CacheableExceptionTest::testExceptions in core/
tests/ Drupal/ Tests/ Core/ Http/ CacheableExceptionTest.php - @dataProvider providerTestExceptions
- CommentBreadcrumbBuilder::build in core/
modules/ comment/ src/ CommentBreadcrumbBuilder.php - Builds the breadcrumb.
File
-
core/
modules/ migrate/ src/ Plugin/ migrate/ process/ Route.php, line 58
Namespace
Drupal\migrate\Plugin\migrate\processView source
class Route extends ProcessPluginBase implements ContainerFactoryPluginInterface {
/**
* The current migration.
*/
protected $migration;
/**
* The path validator service.
*
* @var \Drupal\Core\Path\PathValidatorInterface
*/
protected $pathValidator;
/**
* {@inheritdoc}
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, PathValidatorInterface $path_validator) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->migration = $migration;
$this->pathValidator = $path_validator;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration = NULL) {
return new static($configuration, $plugin_id, $plugin_definition, $migration, $container->get('path.validator'));
}
/**
* {@inheritdoc}
*
* Set the destination route information based on the source link_path.
*/
public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
if (is_string($value)) {
$link_path = $value;
$options = [];
}
else {
[
$link_path,
$options,
] = $value;
}
$extracted = $this->pathValidator
->getUrlIfValidWithoutAccessCheck($link_path);
$route = [];
if ($extracted) {
if ($extracted->isExternal()) {
$route['route_name'] = NULL;
$route['route_parameters'] = [];
$route['options'] = $options;
$route['url'] = $extracted->getUri();
}
else {
$route['route_name'] = $extracted->getRouteName();
$route['route_parameters'] = $extracted->getRouteParameters();
$route['options'] = $extracted->getOptions();
if (isset($options['query'])) {
// If the querystring is stored as a string (as in D6), convert it
// into an array.
if (is_string($options['query'])) {
parse_str($options['query'], $old_query);
}
else {
$old_query = $options['query'];
}
$options['query'] = $route['options']['query'] + $old_query;
unset($route['options']['query']);
}
$route['options'] = $route['options'] + $options;
$route['url'] = NULL;
}
}
return $route;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin_id of the plugin instance. | 2 | |
ProcessPluginBase::multiple | public | function | Indicates whether the returned value requires multiple handling. | Overrides MigrateProcessInterface::multiple | 3 |
Route::$migration | protected | property | The current migration. | ||
Route::$pathValidator | protected | property | The path validator service. | ||
Route::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | |
Route::transform | public | function | Set the destination route information based on the source link_path. | Overrides ProcessPluginBase::transform | |
Route::__construct | public | function |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.