AbstractEnhancer.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Routing\Enhancer;
 
use ‪TYPO3\CMS\Core\Routing\Aspect\AspectInterface;
use ‪TYPO3\CMS\Core\Routing\Aspect\ModifiableAspectInterface;
use ‪TYPO3\CMS\Core\Routing\Route;
 
abstract class ‪AbstractEnhancer implements ‪EnhancerInterface
{
    protected ‪$aspects = [];
 
    protected ‪$variableProcessor;
 
    protected function ‪applyRouteAspects(‪Route $route, array ‪$aspects, string $namespace = null)
    {
        if (empty(‪$aspects)) {
            return;
        }
        ‪$aspects = $this->‪getVariableProcessor()
            ->‪deflateKeys($aspects, $namespace, $route->‪getArguments());
        $route->‪setAspects(‪$aspects);
    }
 
    protected function ‪applyRequirements(‪Route $route, array $requirements, string $namespace = null)
    {
        $requirements = $this->‪getVariableProcessor()
            ->‪deflateKeys($requirements, $namespace, $route->‪getArguments());
        // only keep requirements that are actually part of the current route path
        $requirements = $this->‪filterValuesByPathVariables($route, $requirements);
        // Symfony's behavior on applying pattern for parameters just concerns values
        // to be passed either to URL or to internal parameters - they are always the
        // same, without any transformation.
        //
        // TYPO3 extends ("enhances") this behavior by making a difference between values
        // for generation (resulting in a URL) and matching (resulting in query parameters)
        // having the following implications and meaning:
        //
        // + since requirements in classic Symfony focus on parameters in URLs
        //   and aspects define a mapping between URL part (e.g. 'some-example-news')
        //   and the corresponding internal argument (e.g. 'tx_news_pi1[news]=123')
        // + thus, the requirement definition cannot be used for resolving and generating
        //   a route at the same time (it would have to be e.g. `[\w_._]+` AND `\d+`)
        //
        // Symfony's default regular expression pattern `[^/]+` (see
        // `RouteCompiler::compilePattern()`) has to be overridden with `.+` to
        // allow URI parameters like `some-example-news/january` as well.
        //
        // Existing `requirements` for TYPO3 route enhancers are not modified, only those
        // that are not defined and would use Symfony's default pattern.
        $requirements = $this->‪defineValuesByAspect($route, $requirements, '.+');
        $route->setRequirements($requirements);
    }
 
    protected function ‪filterValuesByPathVariables(‪Route $route, array $values): array
    {
        return array_intersect_key(
            $values,
            array_flip($route->compile()->getPathVariables())
        );
    }
 
    protected function ‪overrideValuesByAspect(‪Route $route, array $values, string $targetValue): array
    {
        foreach (array_keys($route->‪getAspects()) as $variableName) {
            $values[$variableName] = $targetValue;
        }
        return $values;
    }
 
    protected function ‪defineValuesByAspect(‪Route $route, array $values, string $targetValue): array
    {
        foreach (array_keys($route->‪getAspects()) as $variableName) {
            if (isset($values[$variableName])) {
                continue;
            }
            $values[$variableName] = $targetValue;
        }
        return $values;
    }
 
    protected function ‪modifyRoutePath(string $routePath): string
    {
        $substitutes = [];
        foreach ($this->aspects as $variableName => $aspect) {
            if (!$aspect instanceof ‪ModifiableAspectInterface) {
                continue;
            }
            $value = $aspect->modify();
            if ($value !== null) {
                $substitutes['{' . $variableName . '}'] = $value;
                $substitutes['{!' . $variableName . '}'] = $value;
            }
        }
        return str_replace(
            array_keys($substitutes),
            array_values($substitutes),
            $routePath
        );
    }
 
    protected function ‪resolveType(‪Route $route, array &$remainingQueryParameters): string
    {
        $type = $remainingQueryParameters['type'] ?? 0;
        $decoratedParameters = $route->getOption('_decoratedParameters');
        if (isset($decoratedParameters['type'])) {
            $type = $decoratedParameters['type'];
            unset($decoratedParameters['type']);
            $remainingQueryParameters = array_replace_recursive(
                $remainingQueryParameters,
                $decoratedParameters
            );
        }
        return (string)$type;
    }
 
    protected function ‪getVariableProcessor(): ‪VariableProcessor
    {
        if (isset($this->variableProcessor)) {
            return ‪$this->variableProcessor;
        }
        return $this->variableProcessor = new ‪VariableProcessor();
    }
 
    public function ‪setAspects(array ‪$aspects): void
    {
        $this->aspects = ‪$aspects;
    }
 
    public function ‪getAspects(): array
    {
        return ‪$this->aspects;
    }
}