Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. PrefixTrait.php

trait PrefixTrait

@internal

@author Nicolas Grekas <p@tchwork.com>

Hierarchy

  • trait \Symfony\Component\Routing\Loader\Configurator\Traits\PrefixTrait
2 files declare their use of PrefixTrait
XmlFileLoader.php in vendor/symfony/routing/Loader/XmlFileLoader.php
YamlFileLoader.php in vendor/symfony/routing/Loader/YamlFileLoader.php

File

vendor/symfony/routing/Loader/Configurator/Traits/PrefixTrait.php, line 22

Namespace

Symfony\Component\Routing\Loader\Configurator\Traits
View source
trait PrefixTrait {
    protected final function addPrefix(RouteCollection $routes, string|array $prefix, bool $trailingSlashOnRoot) : void {
        if (\is_array($prefix)) {
            foreach ($prefix as $locale => $localePrefix) {
                $prefix[$locale] = trim(trim($localePrefix), '/');
            }
            foreach ($routes->all() as $name => $route) {
                if (null === ($locale = $route->getDefault('_locale'))) {
                    $priority = $routes->getPriority($name) ?? 0;
                    $routes->remove($name);
                    foreach ($prefix as $locale => $localePrefix) {
                        $localizedRoute = clone $route;
                        $localizedRoute->setDefault('_locale', $locale);
                        $localizedRoute->setRequirement('_locale', preg_quote($locale));
                        $localizedRoute->setDefault('_canonical_route', $name);
                        $localizedRoute->setPath($localePrefix . (!$trailingSlashOnRoot && '/' === $route->getPath() ? '' : $route->getPath()));
                        $routes->add($name . '.' . $locale, $localizedRoute, $priority);
                    }
                }
                elseif (!isset($prefix[$locale])) {
                    throw new \InvalidArgumentException(\sprintf('Route "%s" with locale "%s" is missing a corresponding prefix in its parent collection.', $name, $locale));
                }
                else {
                    $route->setPath($prefix[$locale] . (!$trailingSlashOnRoot && '/' === $route->getPath() ? '' : $route->getPath()));
                    $routes->add($name, $route, $routes->getPriority($name) ?? 0);
                }
            }
            return;
        }
        $routes->addPrefix($prefix);
        if (!$trailingSlashOnRoot) {
            $rootPath = (new Route(trim(trim($prefix), '/') . '/'))->getPath();
            foreach ($routes->all() as $route) {
                if ($route->getPath() === $rootPath) {
                    $route->setPath(rtrim($rootPath, '/'));
                }
            }
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary
PrefixTrait::addPrefix final protected function

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal