Symfony Profiler

<?php
declare(strict_types=1);
/*
* This file is part of Contao.
*
* (c) Leo Feyer
*
* @license LGPL-3.0-or-later
*/
namespace Contao\CoreBundle\Routing\Page;
use Contao\PageModel;
use Doctrine\DBAL\Connection;
class PageRegistry
{
private const DISABLE_CONTENT_COMPOSITION = ['redirect', 'forward', 'logout'];
private Connection $connection;
private ?array $urlPrefixes = null;
private ?array $urlSuffixes = null;
/**
* @var array<RouteConfig>
*/
private array $routeConfigs = [];
/**
* @var array<DynamicRouteInterface>
*/
private array $routeEnhancers = [];
/**
* @var array<ContentCompositionInterface|bool>
*/
private array $contentComposition = [];
public function __construct(Connection $connection)
{
$this->connection = $connection;
}
/**
* Returns the route for a page.
*
* If no path is configured (is null), the route will accept
* any parameters after the page alias (e.g. "en/page-alias/foo/bar.html").
*
* A route enhancer might enhance the route for a specific page.
*/
public function getRoute(PageModel $pageModel): PageRoute
{
$type = $pageModel->type;
$config = $this->routeConfigs[$type] ?? new RouteConfig();
$defaults = $config->getDefaults();
$requirements = $config->getRequirements();
$options = $config->getOptions();
$path = $config->getPath();
if (false === $path) {
$path = '';
$options['compiler_class'] = UnroutablePageRouteCompiler::class;
} elseif (null === $path) {
$path = '/'.($pageModel->alias ?: $pageModel->id).'{!parameters}';
$defaults['parameters'] = '';
$requirements['parameters'] = $pageModel->requireItem ? '/.+?' : '(/.+?)?';
}
$route = new PageRoute($pageModel, $path, $defaults, $requirements, $options, $config->getMethods());
if (null !== $config->getUrlSuffix()) {
$route->setUrlSuffix($config->getUrlSuffix());
}
if (!isset($this->routeEnhancers[$type])) {
return $route;
}
/** @var DynamicRouteInterface $enhancer */
$enhancer = $this->routeEnhancers[$type];
$enhancer->configurePageRoute($route);
return $route;
}
public function getPathRegex(): array
{
$prefixes = [];
foreach ($this->routeConfigs as $type => $config) {
$regex = $config->getPathRegex();
if (null !== $regex) {
$prefixes[$type] = $regex;
}
}
return $prefixes;
}
public function supportsContentComposition(PageModel $pageModel): bool
{
if (!isset($this->contentComposition[$pageModel->type])) {
return !\in_array($pageModel->type, self::DISABLE_CONTENT_COMPOSITION, true);
}
$service = $this->contentComposition[$pageModel->type];
if ($service instanceof ContentCompositionInterface) {
return $service->supportsContentComposition($pageModel);
}
return (bool) $service;
}
/**
* @return array<string>
*/
public function getUrlPrefixes(): array
{
$this->initializePrefixAndSuffix();
return $this->urlPrefixes;
}
/**
* @return array<string>
*/
public function getUrlSuffixes(): array
{
$this->initializePrefixAndSuffix();
return $this->urlSuffixes;
}
/**
* @param ContentCompositionInterface|bool $contentComposition
*/
public function add(string $type, RouteConfig $config, DynamicRouteInterface $routeEnhancer = null, $contentComposition = true): self
{
// Override existing pages with the same identifier
$this->routeConfigs[$type] = $config;
if (null !== $routeEnhancer) {
$this->routeEnhancers[$type] = $routeEnhancer;
}
if (null !== $contentComposition) {
$this->contentComposition[$type] = $contentComposition;
}
$this->urlPrefixes = $this->urlSuffixes = null;
return $this;
}
public function remove(string $type): self
{
unset(
$this->routeConfigs[$type],
$this->routeEnhancers[$type],
$this->contentComposition[$type]
);
$this->urlPrefixes = $this->urlSuffixes = null;
return $this;
}
public function keys(): array
{
return array_keys($this->routeConfigs);
}
/**
* Checks whether this is a routable page type (see #3415).
*/
public function isRoutable(PageModel $page): bool
{
$type = $page->type;
// Any legacy page without route config is routable by default
if (!isset($this->routeConfigs[$type])) {
return true;
}
// Check if page controller is routable
return false !== $this->routeConfigs[$type]->getPath();
}
/**
* @return array<string>
*/
public function getUnroutableTypes(): array
{
$types = [];
foreach ($this->routeConfigs as $type => $config) {
if (false === $config->getPath()) {
$types[] = $type;
}
}
return $types;
}
private function initializePrefixAndSuffix(): void
{
if (null !== $this->urlPrefixes || null !== $this->urlSuffixes) {
return;
}
$results = $this->connection->fetchAllAssociative("SELECT urlPrefix, urlSuffix FROM tl_page WHERE type='root'");
$urlSuffixes = [
array_column($results, 'urlSuffix'),
array_filter(array_map(
static fn (RouteConfig $config) => $config->getUrlSuffix(),
$this->routeConfigs
)),
];
foreach ($this->routeConfigs as $config) {
if (null !== ($suffix = $config->getUrlSuffix())) {
$urlSuffixes[] = [$suffix];
}
}
foreach ($this->routeEnhancers as $enhancer) {
$urlSuffixes[] = $enhancer->getUrlSuffixes();
}
$this->urlSuffixes = array_values(array_unique(array_merge(...$urlSuffixes)));
$this->urlPrefixes = array_values(array_unique(array_column($results, 'urlPrefix')));
}
}

vendor/contao/core-bundle/src/Routing/Page/PageRegistry.php line 72