minor symfony#21536 [TwigBridge] Add docblocks for Twig url and path function to improve ide completion (Haehnchen)

fabpot · fabpot · commit 85ae59a15b83 · 2017-02-16T03:30:17.000-08:00
This PR was merged into the 2.7 branch. Discussion ---------- [TwigBridge] Add docblocks for Twig url and path function to improve ide completion | Q | A | ------------- | --- | Branch? | 2.7 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | License | MIT `RoutingExtension` missed docblock for Twig extension so `path` and `url` are not fully recognized by PhpStorm. Haehnchen/idea-php-symfony2-plugin#864 will add more smarter completion `{{ p<caret> }} -> {{ path('<caret>') }}`, but string parameter is not detected. This will add the minimal docs Commits ------- 93ab017 add docblocks for Twig url and path function to improve ide completion
diff --git a/src/Symfony/Bridge/Twig/Extension/RoutingExtension.php b/src/Symfony/Bridge/Twig/Extension/RoutingExtension.php
@@ -40,11 +40,25 @@ public function getFunctions()
         );
     }
 
+    /**
+     * @param string $name
+     * @param array  $parameters
+     * @param bool   $relative
+     *
+     * @return string
+     */
     public function getPath($name, $parameters = array(), $relative = false)
     {
         return $this->generator->generate($name, $parameters, $relative ? UrlGeneratorInterface::RELATIVE_PATH : UrlGeneratorInterface::ABSOLUTE_PATH);
     }
 
+    /**
+     * @param string $name
+     * @param array  $parameters
+     * @param bool   $schemeRelative
+     *
+     * @return string
+     */
     public function getUrl($name, $parameters = array(), $schemeRelative = false)
     {
         return $this->generator->generate($name, $parameters, $schemeRelative ? UrlGeneratorInterface::NETWORK_PATH : UrlGeneratorInterface::ABSOLUTE_URL);

Original file line number	Diff line number	Diff line change
`@@ -40,11 +40,25 @@ public function getFunctions()`
`40`	`40`	`);`
`41`	`41`	`}`
`42`	`42`
	`43`	`+ /**`
	`44`	`+ * @param string $name`
	`45`	`+ * @param array $parameters`
	`46`	`+ * @param bool $relative`
	`47`	`+ *`
	`48`	`+ * @return string`
	`49`	`+ */`
`43`	`50`	`public function getPath($name, $parameters = array(), $relative = false)`
`44`	`51`	`{`
`45`	`52`	`return $this->generator->generate($name, $parameters, $relative ? UrlGeneratorInterface::RELATIVE_PATH : UrlGeneratorInterface::ABSOLUTE_PATH);`
`46`	`53`	`}`
`47`	`54`
	`55`	`+ /**`
	`56`	`+ * @param string $name`
	`57`	`+ * @param array $parameters`
	`58`	`+ * @param bool $schemeRelative`
	`59`	`+ *`
	`60`	`+ * @return string`
	`61`	`+ */`
`48`	`62`	`public function getUrl($name, $parameters = array(), $schemeRelative = false)`
`49`	`63`	`{`
`50`	`64`	`return $this->generator->generate($name, $parameters, $schemeRelative ? UrlGeneratorInterface::NETWORK_PATH : UrlGeneratorInterface::ABSOLUTE_URL);`