feature #12594 [DX] [HttpKernel] Use "context" argument when logging route in RouterListener (iltar)

fabpot · fabpot · commit 193d69c4d126 · 2015-01-03T10:57:45.000+01:00
This PR was merged into the 2.7 branch. Discussion ---------- [DX] [HttpKernel] Use "context" argument when logging route in RouterListener | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | License | MIT When using the "fingers_crossed" option, I only log stuff when a certain level is reached. I found the matched route with parameters to be extremely useful. The only problem was, that it gets dumped in a string, which reduces readability significantly when having multiple parameters. I've used the context argument to provide the additional information so it becomes easier to read. Especially for formatters that use the context, such as the HtmlFormatter, can really use this. *I've done a quick check and noticed that almost always the information is dumped in the message, while I think it should be in the context. Is this something that should be changed in general?* Commits ------- 448c03f [HttpKernel] RouterListener uses "context" argument when logging route
diff --git a/src/Symfony/Component/HttpKernel/EventListener/RouterListener.php b/src/Symfony/Component/HttpKernel/EventListener/RouterListener.php
@@ -128,7 +128,7 @@ public function onKernelRequest(GetResponseEvent $event)
             }
 
             if (null !== $this->logger) {
-                $this->logger->info(sprintf('Matched route "%s" (parameters: %s)', $parameters['_route'], $this->parametersToString($parameters)));
+                $this->logger->info(sprintf('Matched route "%s"', $parameters['_route']), $parameters);
             }
 
             $request->attributes->add($parameters);
@@ -150,16 +150,6 @@ public function onKernelRequest(GetResponseEvent $event)
         }
     }
 
-    private function parametersToString(array $parameters)
-    {
-        $pieces = array();
-        foreach ($parameters as $key => $val) {
-            $pieces[] = sprintf('"%s": "%s"', $key, (is_string($val) ? $val : json_encode($val)));
-        }
-
-        return implode(', ', $pieces);
-    }
-
     public static function getSubscribedEvents()
     {
         return array(

Original file line number	Diff line number	Diff line change
`@@ -128,7 +128,7 @@ public function onKernelRequest(GetResponseEvent $event)`
`128`	`128`	`}`
`129`	`129`
`130`	`130`	`if (null !== $this->logger) {`
`131`		`- $this->logger->info(sprintf('Matched route "%s" (parameters: %s)', $parameters['_route'], $this->parametersToString($parameters)));`
	`131`	`+ $this->logger->info(sprintf('Matched route "%s"', $parameters['_route']), $parameters);`
`132`	`132`	`}`
`133`	`133`
`134`	`134`	`$request->attributes->add($parameters);`
`@@ -150,16 +150,6 @@ public function onKernelRequest(GetResponseEvent $event)`
`150`	`150`	`}`
`151`	`151`	`}`
`152`	`152`
`153`		`- private function parametersToString(array $parameters)`
`15 8A6D 4`		`- {`
`155`		`- $pieces = array();`
`156`		`- foreach ($parameters as $key => $val) {`
`157`		`- $pieces[] = sprintf('"%s": "%s"', $key, (is_string($val) ? $val : json_encode($val)));`
`158`		`- }`
`159`		`-`
`160`		`- return implode(', ', $pieces);`
`161`		`- }`
`162`		`-`
`163`	`153`	`public static function getSubscribedEvents()`
`164`	`154`	`{`
`165`	`155`	`return array(`