[Router] added appending of new optional document fragment

rodnaph · rodnaph · commit 8e5ec7721f43 · 2014-12-14T22:12:05.000Z
added a new optional parameter to the generate method for the document
fragment. when specified this is appended to generated urls.
diff --git a/src/Symfony/Component/Routing/Generator/Dumper/PhpGeneratorDumper.php b/src/Symfony/Component/Routing/Generator/Dumper/PhpGeneratorDumper.php
@@ -109,15 +109,15 @@ private function generateDeclaredRoutes()
     private function generateGenerateMethod()
     {
         return <<<EOF
-    public function generate(\$name, \$parameters = array(), \$referenceType = self::ABSOLUTE_PATH)
+    public function generate(\$name, \$parameters = array(), \$referenceType = self::ABSOLUTE_PATH, \$fragment = null)
     {
         if (!isset(self::\$declaredRoutes[\$name])) {
             throw new RouteNotFoundException(sprintf('Unable to generate a URL for the named route "%s" as such route does not exist.', \$name));
         }
 
         list(\$variables, \$defaults, \$requirements, \$tokens, \$hostTokens, \$requiredSchemes) = self::\$declaredRoutes[\$name];
 
-        return \$this->doGenerate(\$variables, \$defaults, \$requirements, \$tokens, \$parameters, \$name, \$referenceType, \$hostTokens, \$requiredSchemes);
+        return \$this->doGenerate(\$variables, \$defaults, \$requirements, \$tokens, \$parameters, \$name, \$referenceType, \$hostTokens, \$requiredSchemes, \$fragment);
     }
 EOF;
     }
diff --git a/src/Symfony/Component/Routing/Generator/UrlGenerator.php b/src/Symfony/Component/Routing/Generator/UrlGenerator.php
@@ -128,7 +128,7 @@ public function isStrictRequirements()
     /**
      * {@inheritdoc}
      */
-    public function generate($name, $parameters = array(), $referenceType = self::ABSOLUTE_PATH)
+    public function generate($name, $parameters = array(), $referenceType = self::ABSOLUTE_PATH, $fragment = null)
     {
         if (null === $route = $this->routes->get($name)) {
             throw new RouteNotFoundException(sprintf('Unable to generate a URL for the named route "%s" as such route does not exist.', $name));
@@ -137,15 +137,15 @@ public function generate($name, $parameters = array(), $referenceType = self::AB
         // the Route has a cache of its own and is not recompiled as long as it does not get modified
         $compiledRoute = $route->compile();
 
-        return $this->doGenerate($compiledRoute->getVariables(), $route->getDefaults(), $route->getRequirements(), $compiledRoute->getTokens(), $parameters, $name, $referenceType, $compiledRoute->getHostTokens(), $route->getSchemes());
+        return $this->doGenerate($compiledRoute->getVariables(), $route->getDefaults(), $route->getRequirements(), $compiledRoute->getTokens(), $parameters, $name, $referenceType, $compiledRoute->getHostTokens(), $route->getSchemes(), $fragment);
     }
 
     /**
      * @throws MissingMandatoryParametersException When some parameters are missing that are mandatory for the route
      * @throws InvalidParameterException           When a parameter value for a placeholder is not correct because
      *                                             it does not match the requirement
      */
-    protected function doGenerate($variables, $defaults, $requirements, $tokens, $parameters, $name, $referenceType, $hostTokens, array $requiredSchemes = array())
+    protected function doGenerate($variables, $defaults, $requirements, $tokens, $parameters, $name, $referenceType, $hostTokens, array $requiredSchemes = array(), $fragment)
     {
         $variables = array_flip($variables);
         $mergedParams = array_replace($defaults, $this->context->getParameters(), $parameters);
@@ -284,6 +284,11 @@ protected function doGenerate($variables, $defaults, $requirements, $tokens, $pa
             $url .= '?'.strtr($query, array('%2F' => '/'));
         }
 
+        // add fragment if needed
+        if ($fragment) {
+            $url .= '#' . rawurlencode($fragment);
+        }
+
         return $url;
     }
 
diff --git a/src/Symfony/Component/Routing/Generator/UrlGeneratorInterface.php b/src/Symfony/Component/Routing/Generator/UrlGeneratorInterface.php
@@ -73,6 +73,7 @@ interface UrlGeneratorInterface extends RequestContextAwareInterface
      * @param string      $name          The name of the route
      * @param mixed       $parameters    An array of parameters
      * @param bool|string $referenceType The type of reference to be generated (one of the constants)
+     * @param string      $fragment      The document fragment
      *
      * @return string The generated URL
      *
@@ -83,5 +84,5 @@ interface UrlGeneratorInterface extends RequestContextAwareInterface
      *
      * @api
      */
-    public function generate($name, $parameters = array(), $referenceType = self::ABSOLUTE_PATH);
+    public function generate($name, $parameters = array(), $referenceType = self::ABSOLUTE_PATH, $fragment = null);
 }
diff --git a/src/Symfony/Component/Routing/Router.php b/src/Symfony/Component/Routing/Router.php
@@ -212,9 +212,9 @@ public function getContext()
     /**
      * {@inheritdoc}
      */
-    public function generate($name, $parameters = array(), $referenceType = self::ABSOLUTE_PATH)
+    public function generate($name, $parameters = array(), $referenceType = self::ABSOLUTE_PATH, $fragment = null)
     {
-        return $this->getGenerator()->generate($name, $parameters, $referenceType);
+        return $this->getGenerator()->generate($name, $parameters, $referenceType, $fragment);
     }
 
     /**
diff --git a/src/Symfony/Component/Routing/Tests/Generator/UrlGeneratorTest.php b/src/Symfony/Component/Routing/Tests/Generator/UrlGeneratorTest.php
@@ -649,6 +649,14 @@ public function provideRelativePaths()
         );
     }
 
+    public function testFragmentsCanBeAppendedToUrls()
+    {
+        $routes = $this->getRoutes('test', new Route('/testing'));
+        $url = $this->getGenerator($routes)->generate('test', array(), true, 'frag ment');
+
+        $this->assertEquals('http://localhost/app.php/testing#frag%20ment', $url);
+    }
+
     protected function getGenerator(RouteCollection $routes, array $parameters = array(), $logger = null)
     {
         $context = new RequestContext('/app.php');

Original file line number	Diff line number	Diff line change
`@@ -109,15 +109,15 @@ private function generateDeclaredRoutes()`
`109`	`109`	`private function generateGenerateMethod()`
`110`	`110`	`{`
`111`	`111`	`return <<<EOF`
`112`		`- public function generate(\$name, \$parameters = array(), \$referenceType = self::ABSOLUTE_PATH)`
	`112`	`+ public function generate(\$name, \$parameters = array(), \$referenceType = self::ABSOLUTE_PATH, \$fragment = null)`
`113`	`113`	`{`
`114`	`114`	`if (!isset(self::\$declaredRoutes[\$name])) {`
`115`	`115`	`throw new RouteNotFoundException(sprintf('Unable to generate a URL for the named route "%s" as such route does not exist.', \$name));`
`116`	`116`	`}`
`117`	`117`
`118`	`118`	`list(\$variables, \$defaults, \$requirements, \$tokens, \$hostTokens, \$requiredSchemes) = self::\$declaredRoutes[\$name];`
`119`	`119`
`120`		`- return \$this->doGenerate(\$variables, \$defaults, \$requirements, \$tokens, \$parameters, \$name, \$referenceType, \$hostTokens, \$requiredSchemes);`
	`120`	`+ return \$this->doGenerate(\$variables, \$defaults, \$requirements, \$tokens, \$parameters, \$name, \$referenceType, \$hostTokens, \$requiredSchemes, \$fragment);`
`121`	`121`	`}`
`122`	`122`	`EOF;`
`123`	`123`	`}`
Original file line number	Diff line number	Diff line change
`@@ -73,6 +73,7 @@ interface UrlGeneratorInterface extends RequestContextAwareInterface`
`73`	`73`	`* @param string $name The name of the route`
`74`	`74`	`* @param mixed $parameters An array of parameters`
`75`	`75`	`* @param bool\|string $referenceType The type of reference to be generated (one of the constants)`
	`76`	`+ * @param string $fragment The document fragment`
`76`	`77`	`*`
`77`	`78`	`* @return string The generated URL`
`78`	`79`	`*`
`@@ -83,5 +84,5 @@ interface UrlGeneratorInterface extends RequestContextAwareInterface`
`83`	`84`	`*`
`84`	`85`	`* @api`
`85`	`86`	`*/`
`86`		`- public function generate($name, $parameters = array(), $referenceType = self::ABSOLUTE_PATH);`
	`87`	`+ public function generate($name, $parameters = array(), $referenceType = self::ABSOLUTE_PATH, $fragment = null);`
`87`	`88`	`}`
Original file line number	Diff line number	Diff line change
`@@ -212,9 +212,9 @@ public function getContext()`
`212`	`212`	`/**`
`213`	`213`	`* {@inheritdoc}`
`214`	`214`	`*/`
`215`		`- public function generate($name, $parameters = array(), $referenceType = self::ABSOLUTE_PATH)`
	`215`	`+ public function generate($name, $parameters = array(), $referenceType = self::ABSOLUTE_PATH, $fragment = null)`
`216`	`216`	`{`
`217`		`- return $this->getGenerator()->generate($name, $parameters, $referenceType);`
	`217`	`+ return $this->getGenerator()->generate($name, $parameters, $referenceType, $fragment);`
`218`	`218`	`}`
`219`	`219`
`220`	`220`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -649,6 +649,14 @@ public function provideRelativePaths()`
`649`	`649`	`);`
`650`	`650`	`}`
`651`	`651`
	`652`	`+ public function testFragmentsCanBeAppendedToUrls()`
	`653`	`+ {`
	`654`	`+ $routes = $this->getRoutes('test', new Route('/testing'));`
	`655`	`+ $url = $this->getGenerator($routes)->generate('test', array(), true, 'frag ment');`
	`656`	`+`
	`657`	`+ $this->assertEquals('http://localhost/app.php/testing#frag%20ment', $url);`
	`658`	`+ }`
	`659`	`+`
`652`	`660`	`protected function getGenerator(RouteCollection $routes, array $parameters = array(), $logger = null)`
`653`	`661`	`{`
`654`	`662`	`$context = new RequestContext('/app.php');`