vendor/contao/core-bundle/src/Routing/FrontendLoader.php line 30

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of Contao.
  7.  *
  8.  * (c) Leo Feyer
  9.  *
  10.  * @license LGPL-3.0-or-later
  11.  */
  13. namespace Contao\CoreBundle\Routing;
  15. use Contao\CoreBundle\ContaoCoreBundle;
  16. use Symfony\Component\Config\Loader\Loader;
  17. use Symfony\Component\Routing\Route;
  18. use Symfony\Component\Routing\RouteCollection;
  20. class FrontendLoader extends Loader
  21. {
  22.     private bool $prependLocale;
  23.     private string $urlSuffix;
  25.     /**
  26.      * @internal
  27.      */
  28.     public function __construct(bool $prependLocale, string $urlSuffix = '.html')
  29.     {
  30.         trigger_deprecation('contao/core-bundle', '4.10', 'Using the "Contao\CoreBundle\Routing\FrontendLoader" class has been deprecated and will no longer work in Contao 5.0. Use Symfony routing instead.');
  32.         $this->prependLocale = $prependLocale;
  33.         $this->urlSuffix = $urlSuffix;
  34.     }
  36.     public function load($resource, ?string $type = null): RouteCollection
  37.     {
  38.         $routes = new RouteCollection();
  40.         $defaults = [
  41.             '_controller' => 'Contao\CoreBundle\Controller\FrontendController::indexAction',
  42.             '_scope' => ContaoCoreBundle::SCOPE_FRONTEND,
  43.         ];
  45.         $this->addFrontendRoute($routes, $defaults);
  46.         $this->addIndexRoute($routes, $defaults);
  48.         return $routes;
  49.     }
  51.     public function supports($resource, ?string $type = null): bool
  52.     {
  53.         return 'contao_frontend' === $type;
  54.     }
  56.     /**
  57.      * Adds the frontend route, which is language-aware.
  58.      */
  59.     private function addFrontendRoute(RouteCollection $routes, array $defaults): void
  60.     {
  61.         $route = new Route('/{alias}'.$this->urlSuffix, $defaults, ['alias' => '.+']);
  63.         $this->addLocaleToRoute($route);
  65.         $routes->add('contao_frontend', $route);
  66.     }
  68.     /**
  69.      * Adds a route to redirect a user to the index page.
  70.      */
  71.     private function addIndexRoute(RouteCollection $routes, array $defaults): void
  72.     {
  73.         $route = new Route('/', $defaults);
  75.         $this->addLocaleToRoute($route);
  77.         $routes->add('contao_index', $route);
  78.     }
  80.     /**
  81.      * Adds the locale to the route if prepend_locale is enabled.
  82.      */
  83.     private function addLocaleToRoute(Route $route): void
  84.     {
  85.         if (!$this->prependLocale) {
  86.             return;
  87.         }
  89.         $route->setPath('/{_locale}'.$route->getPath());
  90.         $route->addRequirements(['_locale' => '[a-z]{2}(\-[A-Z]{2})?']);
  91.     }
  92. }