feature #29254 [FrameworkBundle] Added the condition routing option to the debug router command (soufianZantar)

fabpot · fabpot · commit 90b68826e94e · 2019-03-04T10:24:25.000+01:00
This PR was squashed before being merged into the 4.3-dev branch (closes #29254). Discussion ---------- [FrameworkBundle] Added the condition routing option to the debug router command | Q | A | ------------- | --- | Branch? | master  | Bug fix? | no | New feature? | no  | BC breaks? | no  | Deprecations? | no  | Tests pass? | yes  | Fixed tickets |  | License | MIT | Doc PR |   This PR will add the condition routing option to debug:router command, to show if a route have conditions or not and showing this conditions. Commits ------- 92bdc9b [FrameworkBundle] Added the condition routing option to the debug router command
diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/JsonDescriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/JsonDescriptor.php
@@ -193,7 +193,7 @@ private function writeData(array $data, array $options)
      */
     protected function getRouteData(Route $route)
     {
-        return [
+        $data = [
             'path' => $route->getPath(),
             'pathRegex' => $route->compile()->getRegex(),
             'host' => '' !== $route->getHost() ? $route->getHost() : 'ANY',
diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/MarkdownDescriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/MarkdownDescriptor.php
@@ -60,6 +60,10 @@ protected function describeRoute(Route $route, array $options = [])
             ."\n".'- Requirements: '.($route->getRequirements() ? $this->formatRouterConfig($route->getRequirements()) : 'NO CUSTOM')
             ."\n".'- Options: '.$this->formatRouterConfig($route->getOptions());
 
+        if ('' !== $route->getCondition()) {
+            $output .= "\n".'- Condition: '.$route->getCondition();
+        }
+
         $this->write(isset($options['name'])
             ? $options['name']."\n".str_repeat('-', \strlen($options['name']))."\n\n".$output
             : $output);
diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/TextDescriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/TextDescriptor.php
@@ -92,6 +92,10 @@ protected function describeRoute(Route $route, array $options = [])
             ['Options', $this->formatRouterConfig($route->getOptions())],
         ];
 
+        if ('' !== $route->getCondition()) {
+            $tableRows[] = array('Condition', $route->getCondition());
+        }
+
         $table = new Table($this->getOutput());
         $table->setHeaders($tableHeaders)->setRows($tableRows);
         $table->render();
diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/XmlDescriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/XmlDescriptor.php
@@ -215,6 +215,11 @@ private function getRouteDocument(Route $route, string $name = null): \DOMDocume
             }
         }
 
+        if ('' !== $route->getCondition()) {
+            $routeXML->appendChild($hostXML = $dom->createElement('condition'));
+            $hostXML->appendChild(new \DOMText($route->getCondition()));
+        }
+
         return $dom;
     }
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/ObjectsProvider.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/ObjectsProvider.php
@@ -53,7 +53,8 @@ public static function getRoutes()
                 ['opt1' => 'val1', 'opt2' => 'val2'],
                 'localhost',
                 ['http', 'https'],
-                ['put', 'post']
+                ['put', 'post'],
+                "context.getMethod() in ['GET', 'HEAD', 'POST']"
             ),
         ];
     }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_2.json b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_2.json
@@ -12,5 +12,6 @@
         "compiler_class": "Symfony\\Component\\Routing\\RouteCompiler",
         "opt1": "val1",
         "opt2": "val2"
-    }
+    },
+    "condition": "context.getMethod() in ['GET', 'HEAD', 'POST']"
 }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_2.md b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_2.md
@@ -11,3 +11,4 @@
     - `compiler_class`: Symfony\Component\Routing\RouteCompiler
     - `opt1`: val1
     - `opt2`: val2
+- Condition: context.getMethod() in ['GET', 'HEAD', 'POST']
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_2.txt b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_2.txt
@@ -14,4 +14,5 @@
 [39;49m| Options      | compiler_class: Symfony\Component\Routing\RouteCompiler[39;49m[39;49m           |[39;49m
 [39;49m|              | [39;49m[39;49mopt1: val1[39;49m[39;49m                                                        |[39;49m
 [39;49m|              | [39;49mopt2: val2                                                        |
+| Condition    | context.getMethod() in ['GET', 'HEAD', 'POST']                    |
 +--------------+-------------------------------------------------------------------+
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_2.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_2.xml
@@ -11,4 +11,5 @@
     <option key="opt1">val1</option>
     <option key="opt2">val2</option>
   </options>
+  <condition>context.getMethod() in ['GET', 'HEAD', 'POST']</condition>
 </route>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_1.json b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_1.json
@@ -33,6 +33,7 @@
             "compiler_class": "Symfony\\Component\\Routing\\RouteCompiler",
             "opt1": "val1",
             "opt2": "val2"
-        }
+        },
+        "condition": "context.getMethod() in ['GET', 'HEAD', 'POST']"
     }
 }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_1.md b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_1.md
@@ -34,4 +34,5 @@ route_2
     - `compiler_class`: Symfony\Component\Routing\RouteCompiler
     - `opt1`: val1
     - `opt2`: val2
+- Condition: context.getMethod() in ['GET', 'HEAD', 'POST']
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_1.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/route_collection_1.xml
@@ -31,5 +31,6 @@
       <option key="opt1">val1</option>
       <option key="opt2">val2</option>
     </options>
+    <condition>context.getMethod() in ['GET', 'HEAD', 'POST']</condition>
   </route>
 </routes>

Original file line number	Diff line number	Diff line change
`@@ -193,7 +193,7 @@ private function writeData(array $data, array $options)`
`193`	`193`	`*/`
`194`	`194`	`protected function getRouteData(Route $route)`
`195`	`195`	`{`
`196`		`- return [`
	`196`	`+ $data = [`
`197`	`197`	`'path' => $route->getPath(),`
`198`	`198`	`'pathRegex' => $route->compile()->getRegex(),`
`199`	`199`	`'host' => '' !== $route->getHost() ? $route->getHost() : 'ANY',`
Original file line number	Diff line number	Diff line change
`@@ -215,6 +215,11 @@ private function getRouteDocument(Route $route, string $name = null): \DOMDocume`
`215`	`215`	`}`
`216`	`216`	`}`
`217`	`217`
	`218`	`+ if ('' !== $route->getCondition()) {`
	`219`	`+ $routeXML->appendChild($hostXML = $dom->createElement('condition'));`
	`220`	`+ $hostXML->appendChild(new \DOMText($route->getCondition()));`
	`221`	`+ }`
	`222`	`+`
`218`	`223`	`return $dom;`
`219`	`224`	`}`
`220`	`225`
Original file line number	Diff line number	Diff line change
`@@ -12,5 +12,6 @@`
`12`	`12`	`"compiler_class": "Symfony\\Component\\Routing\\RouteCompiler",`
`13`	`13`	`"opt1": "val1",`
`14`	`14`	`"opt2": "val2"`
`15`		`- }`
	`15`	`+ },`
	`16`	`+ "condition": "context.getMethod() in ['GET', 'HEAD', 'POST']"`
`16`	`17`	`}`
-Original file line number
+Diff line change
 [39;49m| Options      | compiler_class: Symfony\Component\Routing\RouteCompiler[39;49m[39;49m           |[39;49m
 [39;49m|              | [39;49m[39;49mopt1: val1[39;49m[39;49m                                                        |[39;49m
 [39;49m|              | [39;49mopt2: val2                                                        |
 +| Condition    | context.getMethod() in ['GET', 'HEAD', 'POST']                    |
 +--------------+-------------------------------------------------------------------+
Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,7 @@`
`33`	`33`	`"compiler_class": "Symfony\\Component\\Routing\\RouteCompiler",`
`34`	`34`	`"opt1": "val1",`
`35`	`35`	`"opt2": "val2"`
`36`		`- }`
	`36`	`+ },`
	`37`	`+ "condition": "context.getMethod() in ['GET', 'HEAD', 'POST']"`
`37`	`38`	`}`
`38`	`39`	`}`