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 Do not inherit from this class; decorate the "contao.routing.frontend_loader" service instead
  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.             '_token_check' => true,
  42.             '_controller' => 'Contao\CoreBundle\Controller\FrontendController::indexAction',
  43.             '_scope' => ContaoCoreBundle::SCOPE_FRONTEND,
  44.         ];
  46.         $this->addFrontendRoute($routes, $defaults);
  47.         $this->addIndexRoute($routes, $defaults);
  49.         return $routes;
  50.     }
  52.     public function supports($resource, string $type = null): bool
  53.     {
  54.         return 'contao_frontend' === $type;
  55.     }
  57.     /**
  58.      * Adds the frontend route, which is language-aware.
  59.      */
  60.     private function addFrontendRoute(RouteCollection $routes, array $defaults): void
  61.     {
  62.         $route = new Route('/{alias}'.$this->urlSuffix, $defaults, ['alias' => '.+']);
  64.         $this->addLocaleToRoute($route);
  66.         $routes->add('contao_frontend', $route);
  67.     }
  69.     /**
  70.      * Adds a route to redirect a user to the index page.
  71.      */
  72.     private function addIndexRoute(RouteCollection $routes, array $defaults): void
  73.     {
  74.         $route = new Route('/', $defaults);
  76.         $this->addLocaleToRoute($route);
  78.         $routes->add('contao_index', $route);
  79.     }
  81.     /**
  82.      * Adds the locale to the route if prepend_locale is enabled.
  83.      */
  84.     private function addLocaleToRoute(Route $route): void
  85.     {
  86.         if (!$this->prependLocale) {
  87.             return;
  88.         }
  90.         $route->setPath('/{_locale}'.$route->getPath());
  91.         $route->addRequirements(['_locale' => '[a-z]{2}(\-[A-Z]{2})?']);
  92.     }
  93. }