function RouteInfoController::routeList

Builds the routes overview page.

Return value

array A render array as expected by the renderer.

File

src/Controller/RouteInfoController.php, line 55

Class

RouteInfoController

Provides route responses for the route info pages.

Namespace

Code

public function routeList() : array {
    $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 (str_contains($route->getPath(), '{')) {
            $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;
}