class RouteInfoController
Same name in other branches
- 8.x-1.x src/Controller/RouteInfoController.php \Drupal\devel\Controller\RouteInfoController
- 5.x src/Controller/RouteInfoController.php \Drupal\devel\Controller\RouteInfoController
Provides route responses for the route info pages.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait
- class \Drupal\devel\Controller\RouteInfoController extends \Drupal\Core\Controller\ControllerBase
Expanded class hierarchy of RouteInfoController
File
-
src/
Controller/ RouteInfoController.php, line 18
Namespace
Drupal\devel\ControllerView source
class RouteInfoController extends ControllerBase {
/**
* The route provider.
*
* @var \Drupal\Core\Routing\RouteProviderInterface
*/
protected $routeProvider;
/**
* The router service.
*
* @var \Symfony\Component\Routing\RouterInterface
*/
protected $router;
/**
* The dumper service.
*
* @var \Drupal\devel\DevelDumperManagerInterface
*/
protected $dumper;
/**
* RouterInfoController constructor.
*
* @param \Drupal\Core\Routing\RouteProviderInterface $provider
* The route provider.
* @param \Symfony\Component\Routing\RouterInterface $router
* The router service.
* @param \Drupal\devel\DevelDumperManagerInterface $dumper
* The dumper service.
*/
public function __construct(RouteProviderInterface $provider, RouterInterface $router, DevelDumperManagerInterface $dumper) {
$this->routeProvider = $provider;
$this->router = $router;
$this->dumper = $dumper;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container->get('router.route_provider'), $container->get('router.no_access_checks'), $container->get('devel.dumper'));
}
/**
* Builds the routes overview page.
*
* @return array
* A render array as expected by the renderer.
*/
public function routeList() {
$headers = [
$this->t('Route Name'),
$this->t('Path'),
$this->t('Allowed Methods'),
$this->t('Operations'),
];
$rows = [];
foreach ($this->routeProvider
->getAllRoutes() as $route_name => $route) {
$row['name'] = [
'data' => $route_name,
'filter' => TRUE,
];
$row['path'] = [
'data' => $route->getPath(),
'filter' => TRUE,
];
$row['methods']['data'] = [
'#theme' => 'item_list',
'#items' => $route->getMethods(),
'#empty' => $this->t('ANY'),
'#context' => [
'list_style' => 'comma-list',
],
];
// We cannot resolve routes with dynamic parameters from route path. For
// these routes we pass the route name.
// @see ::routeItem()
if (strpos($route->getPath(), '{') !== FALSE) {
$parameters = [
'query' => [
'route_name' => $route_name,
],
];
}
else {
$parameters = [
'query' => [
'path' => $route->getPath(),
],
];
}
$row['operations']['data'] = [
'#type' => 'operations',
'#links' => [
'devel' => [
'title' => $this->t('Devel'),
'url' => Url::fromRoute('devel.route_info.item', [], $parameters),
'attributes' => [
'class' => [
'use-ajax',
],
'data-dialog-type' => 'modal',
'data-dialog-options' => Json::encode([
'width' => 700,
'minHeight' => 500,
]),
],
],
],
];
$rows[] = $row;
}
$output['routes'] = [
'#type' => 'devel_table_filter',
'#filter_label' => $this->t('Search'),
'#filter_placeholder' => $this->t('Enter route name or path'),
'#filter_description' => $this->t('Enter a part of the route name or path to filter by.'),
'#header' => $headers,
'#rows' => $rows,
'#empty' => $this->t('No routes found.'),
'#sticky' => TRUE,
'#attributes' => [
'class' => [
'devel-route-list',
],
],
];
return $output;
}
/**
* Returns a render array representation of the route object.
*
* The method tries to resolve the route from the 'path' or the 'route_name'
* query string value if available. If no route is retrieved from the query
* string parameters it fallbacks to the current route.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The request object.
* @param \Drupal\Core\Routing\RouteMatchInterface $route_match
* The route match.
*
* @return array
* A render array as expected by the renderer.
*/
public function routeDetail(Request $request, RouteMatchInterface $route_match) {
$route = NULL;
// Get the route object from the path query string if available.
if ($path = $request->query
->get('path')) {
try {
$route = $this->router
->match($path);
} catch (\Exception $e) {
$this->messenger()
->addWarning($this->t("Unable to load route for url '%url'", [
'%url' => $path,
]));
}
}
// Get the route object from the route name query string if available and
// the route is not retrieved by path.
if ($route === NULL && ($route_name = $request->query
->get('route_name'))) {
try {
$route = $this->routeProvider
->getRouteByName($route_name);
} catch (\Exception $e) {
$this->messenger()
->addWarning($this->t("Unable to load route '%name'", [
'%name' => $route_name,
]));
}
}
// No route retrieved from path or name specified, get the current route.
if ($route === NULL) {
$route = $route_match->getRouteObject();
}
return $this->dumper
->exportAsRenderable($route);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ControllerBase::$configFactory | protected | property | The configuration factory. | ||
ControllerBase::$currentUser | protected | property | The current user service. | 3 | |
ControllerBase::$entityFormBuilder | protected | property | The entity form builder. | ||
ControllerBase::$entityTypeManager | protected | property | The entity type manager. | ||
ControllerBase::$formBuilder | protected | property | The form builder. | 1 | |
ControllerBase::$keyValue | protected | property | The key-value storage. | 1 | |
ControllerBase::$languageManager | protected | property | The language manager. | 1 | |
ControllerBase::$moduleHandler | protected | property | The module handler. | 1 | |
ControllerBase::$stateService | protected | property | The state service. | ||
ControllerBase::cache | protected | function | Returns the requested cache bin. | ||
ControllerBase::config | protected | function | Retrieves a configuration object. | ||
ControllerBase::container | private | function | Returns the service container. | ||
ControllerBase::currentUser | protected | function | Returns the current user. | 3 | |
ControllerBase::entityFormBuilder | protected | function | Retrieves the entity form builder. | ||
ControllerBase::entityTypeManager | protected | function | Retrieves the entity type manager. | ||
ControllerBase::formBuilder | protected | function | Returns the form builder service. | 1 | |
ControllerBase::keyValue | protected | function | Returns a key/value storage collection. | 1 | |
ControllerBase::languageManager | protected | function | Returns the language manager service. | 1 | |
ControllerBase::moduleHandler | protected | function | Returns the module handler. | 1 | |
ControllerBase::redirect | protected | function | Returns a redirect response object for the specified route. | ||
ControllerBase::state | protected | function | Returns the state storage service. | ||
LoggerChannelTrait::$loggerFactory | protected | property | The logger channel factory service. | ||
LoggerChannelTrait::getLogger | protected | function | Gets the logger for a specific channel. | ||
LoggerChannelTrait::setLoggerFactory | public | function | Injects the logger channel factory. | ||
MessengerTrait::$messenger | protected | property | The messenger. | 17 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 17 | |
MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
RedirectDestinationTrait::$redirectDestination | protected | property | The redirect destination service. | 1 | |
RedirectDestinationTrait::getDestinationArray | protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | ||
RedirectDestinationTrait::getRedirectDestination | protected | function | Returns the redirect destination service. | ||
RedirectDestinationTrait::setRedirectDestination | public | function | Sets the redirect destination service. | ||
RouteInfoController::$dumper | protected | property | The dumper service. | ||
RouteInfoController::$routeProvider | protected | property | The route provider. | ||
RouteInfoController::$router | protected | property | The router service. | ||
RouteInfoController::create | public static | function | Instantiates a new instance of this class. | Overrides ControllerBase::create | |
RouteInfoController::routeDetail | public | function | Returns a render array representation of the route object. | ||
RouteInfoController::routeList | public | function | Builds the routes overview page. | ||
RouteInfoController::__construct | public | function | RouterInfoController constructor. | ||
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. | 2 | |
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. |