Restore methods

UPGRADE-7.2.md

@@ -10,3 +10,10 @@ PagePartBundle
 --------------
 
 - Not passing a HasPagePartsInterface as second parameter in PagePartEvent is deprecated and will be required in 8.0.
+
+
+NodeBundle
+-----------------
+
+- The node-bundle/multidomain-bundle has now some improved logic in the router itself. Using the old router logic is deprecated and the new will be the default in 8.0.
+  To enable the new and improved router, set the `kunstmaan_node.enable_improved_router` config to `true`.

src/Kunstmaan/MultiDomainBundle/DependencyInjection/Configuration.php

@@ -52,6 +52,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                                 ->end()
                             ->end()
                         ->end()
+                    ->end()
                 ->end()
             ->end();
 

src/Kunstmaan/MultiDomainBundle/Router/DomainBasedLocaleRouter.php

@@ -9,10 +9,18 @@
 use Symfony\Component\Routing\Generator\UrlGenerator;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 use Symfony\Component\Routing\Matcher\UrlMatcher;
+use Symfony\Component\Routing\Route;
 use Symfony\Component\Routing\RouteCollection;
 
 class DomainBasedLocaleRouter extends SlugRouter
 {
+    /**
+     * @var RouteCollection
+     *
+     * @deprecated routeCollectionMultiLanguage property is deprecated in 7.2 and will be removed in 8.0. There is no replacement for this property.
+     */
+    protected $routeCollectionMultiLanguage;
+
     private ?array $otherSite = null;
     private array $cachedNodeTranslations = [];
 
@@ -148,6 +156,21 @@ private function getReverseLocaleMap(): array
      */
     public function getRouteCollection(): RouteCollection
     {
+        if (!$this->enabledImprovedRouter) {
+            trigger_deprecation('kunstmaan/multidomain-bundle', '7.2', 'Not enabling the improved router is deprecated and the changed and improved router will be the default in 8.0. Set the "kunstmaan_multi_domain.enable_improved_domain_based_local_router" config to true.');
+
+            if (($this->otherSite && $this->isMultiLanguage($this->otherSite['host'])) || (!$this->otherSite && $this->isMultiLanguage())) {
+                if (!$this->routeCollectionMultiLanguage) {
+                    $this->routeCollectionMultiLanguage = new RouteCollection();
+
+                    $this->addMultiLangPreviewRoute();
+                    $this->addMultiLangSlugRoute();
+                }
+
+                return $this->routeCollectionMultiLanguage;
+            }
+        }
+
         if (!$this->routeCollection) {
             $this->routeCollection = new RouteCollection();
 
@@ -167,6 +190,45 @@ protected function addSlugRoute()
         $this->addRoute('_slug', $routeParameters);
     }
 
+    /**
+     * Add the slug route to the route collection
+     */
+    protected function addMultiLangPreviewRoute()
+    {
+        trigger_deprecation('kunstmaan/multidomain-bundle', '7.2', 'This method is deprecated and will be removed in 8.0.');
+
+        $routeParameters = $this->getPreviewRouteParameters();
+        $this->addMultiLangRoute('_slug_preview', $routeParameters);
+    }
+
+    /**
+     * Add the slug route to the route collection multilanguage
+     */
+    protected function addMultiLangSlugRoute()
+    {
+        trigger_deprecation('kunstmaan/multidomain-bundle', '7.2', 'This method is deprecated and will be removed in 8.0.');
+
+        $routeParameters = $this->getSlugRouteParameters();
+        $this->addMultiLangRoute('_slug', $routeParameters);
+    }
+
+    /**
+     * @param string $name
+     */
+    protected function addMultiLangRoute($name, array $parameters = [])
+    {
+        trigger_deprecation('kunstmaan/multidomain-bundle', '7.2', 'This method is deprecated and will be removed in 8.0.');
+
+        $this->routeCollectionMultiLanguage->add(
+            $name,
+            new Route(
+                $parameters['path'],
+                $parameters['defaults'],
+                $parameters['requirements']
+            )
+        );
+    }
+
     /**
      * Return slug route parameters
      *

src/Kunstmaan/MultiDomainBundle/Tests/Router/DomainBasedLocaleRouterTest.php

@@ -97,6 +97,7 @@ public function testAddMultiLangSlugRoute()
         $request = $this->getRequest('http://singlelangdomain.tld/');
 
         $object = new DomainBasedLocaleRouter($domainConfiguration, $this->getRequestStack($request), $this->getEntityManager(new NodeTranslation()), 'admin');
+        $object->enabledImprovedRouter(true);
 
         $mirror = new \ReflectionClass(DomainBasedLocaleRouter::class);
         $property = $mirror->getProperty('otherSite');
@@ -140,6 +141,7 @@ public function testGetRouteCollection()
 
         /** @var Container $container */
         $object = new DomainBasedLocaleRouter($domainConfiguration, $this->getRequestStack($request), $this->getEntityManager(new NodeTranslation()), 'admin');
+        $object->enabledImprovedRouter(true);
         $mirror = new \ReflectionClass(DomainBasedLocaleRouter::class);
         $property = $mirror->getProperty('otherSite');
         $property->setAccessible(true);
@@ -216,6 +218,9 @@ private function getNodeTranslationRepository($nodeTranslation = null)
 
     private function getDomainBasedLocaleRouter($request, $nodeTranslation = null)
     {
-        return new DomainBasedLocaleRouter($this->getDomainConfiguration(), $this->getRequestStack($request), $this->getEntityManager($nodeTranslation), 'admin');
+        $router = new DomainBasedLocaleRouter($this->getDomainConfiguration(), $this->getRequestStack($request), $this->getEntityManager($nodeTranslation), 'admin');
+        $router->enabledImprovedRouter(true);
+
+        return $router;
     }
 }

src/Kunstmaan/NodeBundle/DependencyInjection/Configuration.php

@@ -57,6 +57,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                         ->booleanNode('enabled')->defaultFalse()->end()
                     ->end()
                 ->end()
+                ->booleanNode('enable_improved_router')->defaultFalse()->end()
             ->end();
 
         return $treeBuilder;

src/Kunstmaan/NodeBundle/DependencyInjection/KunstmaanNodeExtension.php

@@ -42,6 +42,13 @@ public function load(array $configs, ContainerBuilder $container): void
 
         $loader->load('services.yml');
         $loader->load('commands.yml');
+
+        $enableImprovedRouter = $config['enable_improved_router'] ?? false;
+        if (!$enableImprovedRouter) {
+            trigger_deprecation('kunstmaan/node-bundle', '7.2', 'Not setting the "kunstmaan_node.enable_improved_router" config to true is deprecated, it will always be true in 8.0.');
+        }
+        $slugRouter = $container->findDefinition('kunstmaan_node.slugrouter');
+        $slugRouter->addMethodCall('enabledImprovedRouter', [$enableImprovedRouter]);
     }
 
     public function prepend(ContainerBuilder $container): void

src/Kunstmaan/NodeBundle/Router/SlugRouter.php

@@ -52,6 +52,13 @@ class SlugRouter implements RouterInterface
     /** @var string */
     protected $slugPattern;
 
+    /**
+     * NEXT_MAJOR: Remove property
+     *
+     * @internal
+     */
+    protected bool $enabledImprovedRouter = false;
+
     public function __construct(
         DomainConfigurationInterface $domainConfiguration,
         RequestStack $requestStack,
@@ -341,4 +348,14 @@ protected function getEscapedLocales($locales)
 
         return implode('|', $escapedLocales);
     }
+
+    /**
+     * NEXT_MAJOR: Remove method
+     *
+     * @interal
+     */
+    public function enabledImprovedRouter(bool $enabled): void
+    {
+        $this->enabledImprovedRouter = $enabled;
+    }
 }

src/Kunstmaan/NodeBundle/Tests/DependencyInjection/ConfigurationTest.php

@@ -30,6 +30,7 @@ public function testConfigGeneratesAsExpected()
                 'threshold' => 35,
             ],
             'enable_permissions' => true,
+            'enable_improved_router' => false,
         ];
 
         $this->assertProcessedConfigurationEquals([$array], $array);

src/Kunstmaan/NodeBundle/Tests/DependencyInjection/KunstmaanNodeExtensionTest.php

@@ -4,10 +4,13 @@
 
 use Kunstmaan\NodeBundle\DependencyInjection\KunstmaanNodeExtension;
 use Matthias\SymfonyDependencyInjectionTest\PhpUnit\AbstractExtensionTestCase;
+use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;
 use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
 
 class KunstmaanNodeExtensionTest extends AbstractExtensionTestCase
 {
+    use ExpectDeprecationTrait;
+
     /**
      * @return ExtensionInterface[]
      */
@@ -19,7 +22,7 @@ protected function getContainerExtensions(): array
     public function testCorrectParametersHaveBeenSet()
     {
         $this->container->setParameter('twig.form.resources', []);
-        $this->load();
+        $this->load(['enable_improved_router' => true]);
 
         $this->assertContainerBuilderHasParameter('twig.form.resources');
         $this->assertContainerBuilderHasParameter('kunstmaan_node.show_add_homepage', true);
@@ -30,4 +33,15 @@ public function testCorrectParametersHaveBeenSet()
         $this->assertContainerBuilderHasParameter('kunstmaan_node.version_timeout', 3600);
         $this->assertContainerBuilderHasParameter('kunstmaan_node.url_chooser.lazy_increment', 2);
     }
+
+
+    /**
+     * @group legacy
+     */
+    public function testImprovedRouterConfigDeprecation()
+    {
+        $this->expectDeprecation('Since kunstmaan/node-bundle 7.2: Not setting the "kunstmaan_node.enable_improved_router" config to true is deprecated, it will always be true in 8.0.');
+        $this->container->setParameter('twig.form.resources', []);
+        $this->load();
+    }
 }