9.5/core_2_classes_2_routing_2_route_8php_source.html

<?php

declare(strict_types = 1);


namespace ‪TYPO3\CMS\Core\Routing;


/*

 * 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!

 */


use Symfony\Component\Routing\CompiledRoute;

use Symfony\Component\Routing\Route as SymfonyRoute;

use ‪TYPO3\CMS\Core\Routing\Aspect\AspectInterface;

use ‪TYPO3\CMS\Core\Routing\Enhancer\EnhancerInterface;


class ‪Route extends SymfonyRoute

{

    protected ‪$compiled;


    protected ‪$aspects = [];


    public function ‪__construct(

        string $path,

        array $defaults = [],

        array $requirements = [],

        array $options = [],

        ?string $host = '',

        $schemes = [],

        $methods = [],

        ?string $condition = '',

        array ‪$aspects = []

    ) {

        parent::__construct($path, $defaults, $requirements, $options, $host, $schemes, $methods, $condition);

        $this->‪setAspects(‪$aspects);

    }


    public function ‪getArguments(): array

    {

        return $this->getOption('_arguments') ?? [];

    }


    public function ‪addArguments(array $arguments)

    {

        $mergedArguments = $this->‪getArguments();

        foreach ($arguments as $key => $argument) {

            if (isset($mergedArguments[$key])) {

                throw new \OverflowException(

                    sprintf('Cannot override argument %s', $key),

                    1538326790

                );

            }

            $mergedArguments[$key] = $argument;

        }

        $this->setOption('_arguments', $mergedArguments);

    }


    public function ‪getEnhancer(): ?EnhancerInterface

    {

        return $this->getOption('_enhancer') ?? null;

    }


    public function ‪getAspects(): array

    {

        return ‪$this->aspects;

    }


    public function ‪setAspects(array ‪$aspects): self

    {

        $this->aspects = [];

        return $this->‪addAspects($aspects);

    }


    public function ‪addAspects(array ‪$aspects): self

    {

        foreach (‪$aspects as $key => $aspect) {

            if (isset($this->aspects[$key])) {

                throw new \OverflowException(

                    sprintf('Cannot override aspect %s', $key),

                    1538326791

                );

            }

            $this->aspects[$key] = $aspect;

        }

        $this->compiled = null;

        return $this;

    }


    public function ‪getAspect(string $key): ?AspectInterface

    {

        return $this->aspects[$key] ?? null;

    }


    public function ‪hasAspect(string $key): bool

    {

        return array_key_exists($key, $this->aspects);

    }


    public function ‪setAspect(string $key, AspectInterface $aspect): self

    {

        $this->aspects[$key] = $aspect;

        $this->compiled = null;

        return $this;

    }


    public function ‪filterAspects(array $classNames, array $variableNames = []): array

    {

        ‪$aspects = ‪$this->aspects;

        if (empty($classNames) && empty($variableNames)) {

            return ‪$aspects;

        }

        if (!empty($variableNames)) {

            ‪$aspects = array_filter(

                $this->aspects,

                function (string $variableName) use ($variableNames) {

                    return in_array($variableName, $variableNames, true);

                },

                ARRAY_FILTER_USE_KEY

            );

        }

        return array_filter(

            ‪$aspects,

            function (AspectInterface $aspect) use ($classNames) {

                $uses = class_uses($aspect);

                foreach ($classNames as $className) {

                    if (!is_a($aspect, $className)

                        && !in_array($className, $uses, true)

                    ) {

                        return false;

                    }

                }

                return true;

            }

        );

    }

}