[RouterDebugCommand] add link to Controllers

nicoweb · nicoweb · commit 15213725b848 · 2019-03-11T17:20:18.000+01:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/RouterDebugCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/RouterDebugCommand.php
@@ -19,6 +19,7 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
+use Symfony\Component\HttpKernel\Debug\FileLinkFormatter;
 use Symfony\Component\Routing\RouteCollection;
 use Symfony\Component\Routing\RouterInterface;
 
@@ -34,12 +35,14 @@ class RouterDebugCommand extends Command
 {
     protected static $defaultName = 'debug:router';
     private $router;
+    private $fileLinkFormatter;
 
-    public function __construct(RouterInterface $router)
+    public function __construct(RouterInterface $router, FileLinkFormatter $fileLinkFormatter = null)
     {
         parent::__construct();
 
         $this->router = $router;
+        $this->fileLinkFormatter = $fileLinkFormatter;
     }
 
     /**
@@ -74,7 +77,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
     {
         $io = new SymfonyStyle($input, $output);
         $name = $input->getArgument('name');
-        $helper = new DescriptorHelper();
+        $helper = new DescriptorHelper($this->fileLinkFormatter);
         $routes = $this->router->getRouteCollection();
 
         if ($name) {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/TextDescriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/TextDescriptor.php
@@ -23,6 +23,7 @@
 use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use Symfony\Component\HttpKernel\Debug\FileLinkFormatter;
 use Symfony\Component\Routing\Route;
 use Symfony\Component\Routing\RouteCollection;
 
@@ -33,6 +34,13 @@
  */
 class TextDescriptor extends Descriptor
 {
+    private $fileLinkFormatter;
+
+    public function __construct(FileLinkFormatter $fileLinkFormatter = null)
+    {
+        $this->fileLinkFormatter = $fileLinkFormatter;
+    }
+
     /**
      * {@inheritdoc}
      */
@@ -47,16 +55,19 @@ protected function describeRouteCollection(RouteCollection $routes, array $optio
 
         $tableRows = [];
         foreach ($routes->all() as $name => $route) {
+            $controller = $route->getDefault('_controller');
+            list ($controllerClass, $controllerMethod) = explode('::', $controller);
+
             $row = [
                 $name,
                 $route->getMethods() ? implode('|', $route->getMethods()) : 'ANY',
                 $route->getSchemes() ? implode('|', $route->getSchemes()) : 'ANY',
                 '' !== $route->getHost() ? $route->getHost() : 'ANY',
-                $route->getPath(),
+                $this->transformControllerToLink($controllerClass, $controllerMethod, $route->getPath()),
             ];
 
             if ($showControllers) {
-                $controller = $route->getDefault('_controller');
+                $controller = $this->transformControllerToLink($controllerClass, $controllerMethod, $controller);
                 $row[] = $controller ? $this->formatCallable($controller) : '';
             }
 
@@ -101,7 +112,7 @@ protected function describeRoute(Route $route, array $options = [])
         $table->render();
     }
 
-    /**
+/**
      * {@inheritdoc}
      */
     protected function describeContainerParameters(ParameterBag $parameters, array $options = [])
@@ -442,12 +453,39 @@ private function formatRouterConfig(array $config): string
 
         $configAsString = '';
         foreach ($config as $key => $value) {
+            if ('_controller' === $key) {
+                list ($controllerClass, $controllerMethod) = explode('::', $value);
+                $value = $this->transformControllerToLink($controllerClass, $controllerMethod, $value);
+            }
+
             $configAsString .= sprintf("\n%s: %s", $key, $this->formatValue($value));
         }
 
         return trim($configAsString);
     }
 
+    private function transformControllerToLink(string $className, string $method = null, string $anchorText = null)
+    {
+        $fileLink = $this->getFileLink($className, $method);
+
+        return sprintf('<href=%s>%s</>', $fileLink, $anchorText);
+    }
+
+    private function getFileLink(string $className, string $method = null): ?string
+    {
+        try {
+            $r = new \ReflectionClass($className);
+        } catch (\ReflectionException $e) {
+            return null;
+        }
+
+        if (null !== $method) {
+            $r = $r->getMethod($method);
+        }
+
+        return $this->fileLinkFormatter->format($r->getFileName(), $r->getStartLine());
+    }
+
     private function formatCallable($callable): string
     {
         if (\is_array($callable)) {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Helper/DescriptorHelper.php b/src/Symfony/Bundle/FrameworkBundle/Console/Helper/DescriptorHelper.php
@@ -16,6 +16,7 @@
 use Symfony\Bundle\FrameworkBundle\Console\Descriptor\TextDescriptor;
 use Symfony\Bundle\FrameworkBundle\Console\Descriptor\XmlDescriptor;
 use Symfony\Component\Console\Helper\DescriptorHelper as BaseDescriptorHelper;
+use Symfony\Component\HttpKernel\Debug\FileLinkFormatter;
 
 /**
  * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com>
@@ -24,10 +25,10 @@
  */
 class DescriptorHelper extends BaseDescriptorHelper
 {
-    public function __construct()
+    public function __construct(FileLinkFormatter $fileLinkFormatter = null)
     {
         $this
-            ->register('txt', new TextDescriptor())
+            ->register('txt', new TextDescriptor($fileLinkFormatter))
             ->register('xml', new XmlDescriptor())
             ->register('json', new JsonDescriptor())
             ->register('md', new MarkdownDescriptor())
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/console.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/console.xml
@@ -91,6 +91,7 @@
 
         <service id="console.command.router_debug" class="Symfony\Bundle\FrameworkBundle\Command\RouterDebugCommand">
             <argument type="service" id="router" />
+            <argument type="service" id="debug.file_link_formatter" />
             <tag name="console.command" command="debug:router" />
         </service>
 
