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

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.     /**
  23.      * @var bool
  24.      */
  25.     private $prependLocale;
  27.     /**
  28.      * @var string
  29.      */
  30.     private $urlSuffix;
  32.     /**
  33.      * @internal Do not inherit from this class; decorate the "contao.routing.frontend_loader" service instead
  34.      */
  35.     public function __construct(bool $prependLocale, string $urlSuffix = '.html')
  36.     {
  37.         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.', E_USER_DEPRECATED);
  39.         $this->prependLocale = $prependLocale;
  40.         $this->urlSuffix = $urlSuffix;
  41.     }
  43.     public function load($resource, $type = null): RouteCollection
  44.     {
  45.         $routes = new RouteCollection();
  47.         $defaults = [
  48.             '_token_check' => true,
  49.             '_controller' => 'Contao\CoreBundle\Controller\FrontendController::indexAction',
  50.             '_scope' => ContaoCoreBundle::SCOPE_FRONTEND,
  51.         ];
  53.         $this->addFrontendRoute($routes, $defaults);
  54.         $this->addIndexRoute($routes, $defaults);
  56.         return $routes;
  57.     }
  59.     public function supports($resource, $type = null): bool
  60.     {
  61.         return 'contao_frontend' === $type;
  62.     }
  64.     /**
  65.      * Adds the frontend route, which is language-aware.
  66.      */
  67.     private function addFrontendRoute(RouteCollection $routes, array $defaults): void
  68.     {
  69.         $route = new Route('/{alias}'.$this->urlSuffix, $defaults, ['alias' => '.+']);
  71.         $this->addLocaleToRoute($route);
  73.         $routes->add('contao_frontend', $route);
  74.     }
  76.     /**
  77.      * Adds a route to redirect a user to the index page.
  78.      */
  79.     private function addIndexRoute(RouteCollection $routes, array $defaults): void
  80.     {
  81.         $route = new Route('/', $defaults);
  83.         $this->addLocaleToRoute($route);
  85.         $routes->add('contao_index', $route);
  86.     }
  88.     /**
  89.      * Adds the locale to the route if prepend_locale is enabled.
  90.      */
  91.     private function addLocaleToRoute(Route $route): void
  92.     {
  93.         if (!$this->prependLocale) {
  94.             return;
  95.         }
  97.         $route->setPath('/{_locale}'.$route->getPath());
  98.         $route->addRequirements(['_locale' => '[a-z]{2}(\-[A-Z]{2})?']);
  99.     }
  100. }