[Routing] allow using compiled matchers and generators without dumping PHP code

Author: nicolas-grekas

CHANGELOG.md

@@ -1,6 +1,13 @@
 CHANGELOG
 =========
 
+4.3.0
+-----
+
+ * added `CompiledUrlMatcher` and `CompiledUrlMatcherDumper`
+ * added `CompiledUrlGenerator` and `CompiledUrlGeneratorDumper`
+ * deprecated `PhpUrlGeneratorDumped` and `PhpMatcherDumper`
+
 4.2.0
 -----
 

Generator/CompiledUrlGenerator.php

@@ -0,0 +1,58 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Routing\Generator;
+
+use Psr\Log\LoggerInterface;
+use Symfony\Component\Routing\Exception\RouteNotFoundException;
+use Symfony\Component\Routing\RequestContext;
+
+/**
+ * Generates URLs based on rules dumped by CompiledUrlGeneratorDumper.
+ */
+class CompiledUrlGenerator extends UrlGenerator
+{
+    private $compiledRoutes = [];
+    private $defaultLocale;
+
+    public function __construct(array $compiledRoutes, RequestContext $context, LoggerInterface $logger = null, string $defaultLocale = null)
+    {
+        $this->compiledRoutes = $compiledRoutes;
+        $this->context = $context;
+        $this->logger = $logger;
+        $this->defaultLocale = $defaultLocale;
+    }
+
+    public function generate($name, $parameters = [], $referenceType = self::ABSOLUTE_PATH)
+    {
+        $locale = $parameters['_locale']
+            ?? $this->context->getParameter('_locale')
+            ?: $this->defaultLocale;
+
+        if (null !== $locale) {
+            do {
+                if (($this->compiledRoutes[$name.'.'.$locale][1]['_canonical_route'] ?? null) === $name) {
+                    unset($parameters['_locale']);
+                    $name .= '.'.$locale;
+                    break;
+                }
+            } while (false !== $locale = strstr($locale, '_', true));
+        }
+
+        if (!isset($this->compiledRoutes[$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) = $this->compiledRoutes[$name];
+
+        return $this->doGenerate($variables, $defaults, $requirements, $tokens, $parameters, $name, $referenceType, $hostTokens, $requiredSchemes);
+    }
+}

Generator/Dumper/CompiledUrlGeneratorDumper.php

@@ -0,0 +1,73 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Routing\Generator\Dumper;
+
+use Symfony\Component\Routing\Matcher\Dumper\CompiledUrlMatcherDumper;
+
+/**
+ * CompiledUrlGeneratorDumper creates a PHP array to be used with CompiledUrlGenerator.
+ *
+ * @author Fabien Potencier <[email protected]>
+ * @author Tobias Schultze <http://tobion.de>
+ * @author Nicolas Grekas <[email protected]>
+ */
+class CompiledUrlGeneratorDumper extends GeneratorDumper
+{
+    public function getCompiledRoutes(): array
+    {
+        $compiledRoutes = [];
+        foreach ($this->getRoutes()->all() as $name => $route) {
+            $compiledRoute = $route->compile();
+
+            $compiledRoutes[$name] = [
+                $compiledRoute->getVariables(),
+                $route->getDefaults(),
+                $route->getRequirements(),
+                $compiledRoute->getTokens(),
+                $compiledRoute->getHostTokens(),
+                $route->getSchemes(),
+            ];
+        }
+
+        return $compiledRoutes;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function dump(array $options = [])
+    {
+        return <<<EOF
+<?php
+
+// This file has been auto-generated by the Symfony Routing Component.
+
+return [{$this->generateDeclaredRoutes()}
+];
+
+EOF;
+    }
+
+    /**
+     * Generates PHP code representing an array of defined routes
+     * together with the routes properties (e.g. requirements).
+     */
+    private function generateDeclaredRoutes(): string
+    {
+        $routes = '';
+        foreach ($this->getCompiledRoutes() as $name => $properties) {
+            $routes .= sprintf("\n    '%s' => %s,", $name, CompiledUrlMatcherDumper::export($properties));
+        }
+
+        return $routes;
+    }
+}

Generator/Dumper/PhpGeneratorDumper.php

@@ -11,13 +11,17 @@
 
 namespace Symfony\Component\Routing\Generator\Dumper;
 
-use Symfony\Component\Routing\Matcher\Dumper\PhpMatcherDumper;
+@trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.3, use "CompiledUrlGeneratorDumper" instead.', PhpGeneratorDumper::class), E_USER_DEPRECATED);
+
+use Symfony\Component\Routing\Matcher\Dumper\CompiledUrlMatcherDumper;
 
 /**
  * PhpGeneratorDumper creates a PHP class able to generate URLs for a given set of routes.
  *
  * @author Fabien Potencier <[email protected]>
  * @author Tobias Schultze <http://tobion.de>
+ *
+ * @deprecated since Symfony 4.3, use CompiledUrlGeneratorDumper instead.
  */
 class PhpGeneratorDumper extends GeneratorDumper
 {
@@ -92,7 +96,7 @@ private function generateDeclaredRoutes()
             $properties[] = $compiledRoute->getHostTokens();
             $properties[] = $route->getSchemes();
 
-            $routes .= sprintf("        '%s' => %s,\n", $name, PhpMatcherDumper::export($properties));
+            $routes .= sprintf("        '%s' => %s,\n", $name, CompiledUrlMatcherDumper::export($properties));
         }
         $routes .= '    ]';
 

Matcher/CompiledUrlMatcher.php

@@ -0,0 +1,31 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Routing\Matcher;
+
+use Symfony\Component\Routing\Matcher\Dumper\CompiledUrlMatcherTrait;
+use Symfony\Component\Routing\RequestContext;
+
+/**
+ * Matches URLs based on rules dumped by CompiledUrlMatcherDumper.
+ *
+ * @author Nicolas Grekas <[email protected]>
+ */
+class CompiledUrlMatcher extends UrlMatcher
+{
+    use CompiledUrlMatcherTrait;
+
+    public function __construct(array $compiledRoutes, RequestContext $context)
+    {
+        $this->context = $context;
+        list($this->matchHost, $this->staticRoutes, $this->regexpList, $this->dynamicRoutes, $this->checkCondition) = $compiledRoutes;
+    }
+}