如何在Symfony2中获取控制器的所有路由列表？

Question

我有一个控制器，可以实现所有路由/ URL 。 我有想法在所有帮助页面上提供通用索引。

有没有办法让Symfony2中的控制器（来自控制器内）定义所有路由？

Answer 1

你可以做的是使用cmd（最多SF2.6）

php app/console router:debug

使用SF 2.7，命令为

php app/console debug:router

使用SF 3.0命令

php bin/console debug:router

显示所有路线。

如果你为每个控制器定义一个前缀（我推荐），你可以使用

php app/console router:debug | grep "<prefixhere>"

显示所有匹配的路线

显示获取控制器中的所有路径，输出基本相同 我在控制器中使用以下内容（它与路由器中使用的方法相同：symfony组件中的debug命令）

/**
 * @Route("/routes", name="routes")
 * @Method("GET")
 * @Template("routes.html.twig")
 *
 * @return array
 */
public function routeAction()
{
    /** @var Router $router */
    $router = $this->get('router');
    $routes = $router->getRouteCollection();

    foreach ($routes as $route) {
        $this->convertController($route);
    }

    return [
        'routes' => $routes
    ];
}


private function convertController(\Symfony\Component\Routing\Route $route)
{
    $nameParser = $this->get('controller_name_converter');
    if ($route->hasDefault('_controller')) {
        try {
            $route->setDefault('_controller', $nameParser->build($route->getDefault('_controller')));
        } catch (\InvalidArgumentException $e) {
        }
    }
}

routes.html.twig

<table>
{% for route in routes %}
    <tr>
        <td>{{ route.path }}</td>
        <td>{{ route.methods|length > 0 ? route.methods|join(', ') : 'ANY' }}</td>
        <td>{{ route.defaults._controller }}</td>
    </tr>
{% endfor %}
</table>

输出将是：

/_wdt/{token} ANY web_profiler.controller.profiler:toolbarAction 等

Answer 2

你可以获得所有路线，然后从中创建一个数组，然后将该控制器的路线传递给你的树枝。

这不是一个很好的方式，但它的工作原理......对于2.1反正..

    /** @var $router \Symfony\Component\Routing\Router */
    $router = $this->container->get('router');
    /** @var $collection \Symfony\Component\Routing\RouteCollection */
    $collection = $router->getRouteCollection();
    $allRoutes = $collection->all();

    $routes = array();

    /** @var $params \Symfony\Component\Routing\Route */
    foreach ($allRoutes as $route => $params)
    {
        $defaults = $params->getDefaults();

        if (isset($defaults['_controller']))
        {
            $controllerAction = explode(':', $defaults['_controller']);
            $controller = $controllerAction[0];

            if (!isset($routes[$controller])) {
                $routes[$controller] = array();
            }

            $routes[$controller][]= $route;
        }
    }

    $thisRoutes = isset($routes[get_class($this)]) ?
                                $routes[get_class($this)] : null ;

Answer 3

我一直在寻找这样做，在搜索完代码之后，我想出了这个解决方案，它适用于单个控制器（或任何实际的资源）。适用于Symfony 2.4（我没有使用以前的版本进行测试）：

$routeCollection = $this->get('routing.loader')->load('\Path\To\Controller\Class');

foreach ($routeCollection->all() as $routeName => $route) {
   //do stuff with Route (Symfony\Component\Routing\Route)
}

Answer 4

如果有人在这个问题上遇到困难，这就是我在全局树枝范围（符号4）中导出路由的方式。

src/Helper/Route.php

<?php

namespace App\Helper;

use Symfony\Component\Routing\RouterInterface;

class Routes
{
    private $routes = [];

    public function __construct(RouterInterface $router)
    {
        foreach ($router->getRouteCollection()->all() as $route_name => $route) {
            $this->routes[$route_name] = $route->getPath();
        }
    }

    public function getRoutes(): array
    {
        return $this->routes;
    }
}

src/config/packages/twig.yaml

twig:
    globals:
        route_paths: '@App\Helper\Routes'

然后在树枝文件中填充要在脚本中使用的javascript变量

<script>
    var Routes = {
        {% for route_name, route_path in routes_service.routes %}
            {{ route_name }}: '{{ route_path }}',
        {% endfor %}
    }
</script>

Answer 5

在Symfony 4中，我希望将所有路径（包括控制器和操作）放在一个列表中。在rails中，您可以默认使用此功能。

在Symfony中，您需要将参数show-controllers添加到debug:router命令。

如果有人在寻找相同的功能，可以使用：

bin/console debug:router --show-controllers

这将生成如下列表

------------------------------------------------------------------------- -------------------------------------
Name                   Method    Scheme    Host     Path                    Controller
------------------------------------------------------------------------- -------------------------------------
app_some_good_name     ANY       ANY       ANY      /example/example        ExampleBundle:Example:getExample
------------------------------------------------------------------------- -------------------------------------

Answer 6

最安全的方法是使用 symfony 控制器解析器，因为你永远不知道你的控制器是否被定义为完全限定的类名、服务或任何可调用的声明。

    foreach ($this->get('router')->getRouteCollection() as $route) {
        $request = new Request();
        $request->attributes->add($route->getDefaults());

        [$service, $method] = $this->resolver->getController($request);

        // Do whatever you like with the instanciated controller
    }