Aoe\Restler\System\TYPO3\RestlerEnhancer

Complexity

Total Complexity

10

Size/Duplication

Total Lines	87
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	4

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	2
A	getRoutePathRedecorationPattern()	0	4	1
A	decorateForMatching()	0	15	3
A	decorateForGeneration()	0	3	1
A	setAspects()	0	3	1
A	getAspects()	0	4	1
A	isRestlerUrl()	0	4	1

<?php

namespace Aoe\Restler\System\TYPO3;

use Aoe\Restler\System\RestlerBuilderAware;
use TYPO3\CMS\Core\Routing\Aspect\AspectInterface;
use TYPO3\CMS\Core\Routing\Enhancer\DecoratingEnhancerInterface;
use TYPO3\CMS\Core\Routing\RouteCollection;

/**
 * Puts the URLs which should be handled by restler into the current route collection
 * and maps them to the current default route.
 *
 * Please be aware that this seems to have some side effects on other DecoratingEnhancers like PageTypeDecorator
 * routeEnhancers:
 *   RestlerEnhancer:
 *     type: Restler
 *     default: '.json'
 */
class RestlerEnhancer extends RestlerBuilderAware implements DecoratingEnhancerInterface
{
    private $default;

    public function __construct($configuration)
    {
        parent::__construct(null);
        $default = $configuration['default'] ?? '';

        if (!is_string($default)) {
            throw new \InvalidArgumentException('default must be string', 1538327508);
        }

        $this->default = $default;
    }

    /**
     * Gets pattern that can be used to redecorate (undecorate)
     * a potential previously decorated route path.
     *
     * Example:
     * + route path: 'first/second.html'
     * + redecoration pattern: '(?:\.html|\.json)$'
     * -> 'first/second' might be the redecorated route path after
     *    applying the redecoration pattern to preg_match/preg_replace
     *
     * @return string regular expression pattern
     */
    public function getRoutePathRedecorationPattern(): string
    {
        return preg_quote($this->default, '#') . '$';
    }

    /**
     * Decorates route collection to be processed during URL resolving.
     * Executed before invoking routing enhancers.
     *
     * @param RouteCollection $collection
     * @param string $routePath URL path
     */
    public function decorateForMatching(RouteCollection $collection, string $routePath): void
    {
        // set path according to typo3/sysext/core/Classes/Routing/PageRouter.php:132
        $prefixedUrlPath = '/' . trim($routePath, '/');

        if ($this->isRestlerPrefix($prefixedUrlPath)) {
            $this->getRestlerBuilder()->build(null);

            if ($this->isRestlerUrl($prefixedUrlPath)) {
                $defaultRoute = $collection->get('default');
                $defaultRoute->setPath($prefixedUrlPath);
                $collection->add('restler', $defaultRoute);

It seems like $defaultRoute defined by $collection->get('default') on line 69 can be null; however, Symfony\Component\Routing\RouteCollection::add() does not accept null, maybe add an additional type check?

            }
        }
    }

    /**
     * Decorates route collection during URL URL generation.
     * Executed before invoking routing enhancers.
     *
     * @param RouteCollection $collection
     * @param array $parameters query parameters
     */
    public function decorateForGeneration(RouteCollection $collection, array $parameters): void
    {
    }

    /**
     * @param AspectInterface[] $aspects
     */
    public function setAspects(array $aspects): void
    {
    }

    /**
     * @return AspectInterface[]
     */
    public function getAspects(): array
    {
        return [];
    }

    private function isRestlerUrl($uri): bool
    {
        return \Aoe\Restler\System\Restler\Routes::containsUrl($uri);
    }
}