RestlerEnhancer::__construct() - Code Metrics - Inspection of "Feature/typo3 10.1" - AOEpeople/TYPO3_Restler - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#45)

unknown

created 2019-10-07 06:16 UTC

RestlerEnhancer::__construct() A

↳ Parent: RestlerEnhancer

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	5
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

namespace Aoe\Restler\System\TYPO3;

use Aoe\Restler\System\Restler\Builder as RestlerBuilder;
use TYPO3\CMS\Core\Routing\Aspect\AspectInterface;
use TYPO3\CMS\Core\Routing\Enhancer\DecoratingEnhancerInterface;
use TYPO3\CMS\Core\Routing\RouteCollection;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Object\ObjectManager;

class RestlerEnhancer implements DecoratingEnhancerInterface
{
    /**
     * @var RestlerBuilder
     */
    private $restlerBuilder;

    public function __construct($configuration)

    {
        $objectManager = GeneralUtility::makeInstance(ObjectManager::class);
        $this->restlerBuilder = $objectManager->get(RestlerBuilder::class);
    }


    /**
     * 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 '.$';
    }

    /**
     * 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
    {
        $this->restlerBuilder->build(null);

        // set path according to typo3/sysext/core/Classes/Routing/PageRouter.php:132
        $prefixedUrlPath = '/' . trim($routePath, '/');
        
        if ($this->isRestlerUrl($prefixedUrlPath)) {
            $defaultRoute = $collection->get('default');
            $defaultRoute->setPath($prefixedUrlPath);
            $collection->add('restler', $defaultRoute);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        }
    }

    /**
     * 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);
    }

}


1			<?php
2
3			namespace Aoe\Restler\System\TYPO3;
4
5			use Aoe\Restler\System\Restler\Builder as RestlerBuilder;
6			use TYPO3\CMS\Core\Routing\Aspect\AspectInterface;
7			use TYPO3\CMS\Core\Routing\Enhancer\DecoratingEnhancerInterface;
8			use TYPO3\CMS\Core\Routing\RouteCollection;
9			use TYPO3\CMS\Core\Utility\GeneralUtility;
10			use TYPO3\CMS\Extbase\Object\ObjectManager;
11
12			class RestlerEnhancer implements DecoratingEnhancerInterface
13			{
14			/**
15			* @var RestlerBuilder
16			*/
17			private $restlerBuilder;
18
19			public function __construct($configuration)
			0 ignored issues – show Unused Code introduced 2019-10-07 06:32 UTC by Report Bug Copy Issue Report The parameter `$configuration` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
20			{
21			$objectManager = GeneralUtility::makeInstance(ObjectManager::class);
22			$this->restlerBuilder = $objectManager->get(RestlerBuilder::class);
23			}
24
25
26			/**
27			* Gets pattern that can be used to redecorate (undecorate)
28			* a potential previously decorated route path.
29			*
30			* Example:
31			* + route path: 'first/second.html'
32			* + redecoration pattern: '(?:\.html\|\.json)$'
33			* -> 'first/second' might be the redecorated route path after
34			* applying the redecoration pattern to preg_match/preg_replace
35			*
36			* @return string regular expression pattern
37			*/
38			public function getRoutePathRedecorationPattern(): string
39			{
40			return '.$';
41			}
42
43			/**
44			* Decorates route collection to be processed during URL resolving.
45			* Executed before invoking routing enhancers.
46			*
47			* @param RouteCollection $collection
48			* @param string $routePath URL path
49			*/
50			public function decorateForMatching(RouteCollection $collection, string $routePath): void
51			{
52			$this->restlerBuilder->build(null);
53
54			// set path according to typo3/sysext/core/Classes/Routing/PageRouter.php:132
55			$prefixedUrlPath = '/' . trim($routePath, '/');
56
57			if ($this->isRestlerUrl($prefixedUrlPath)) {
58			$defaultRoute = $collection->get('default');
59			$defaultRoute->setPath($prefixedUrlPath);
60			$collection->add('restler', $defaultRoute);
			0 ignored issues – show Bug introduced 2019-10-07 06:32 UTC by Report Bug Copy Issue Report It seems like `$defaultRoute` defined by `$collection->get('default')` on line `58` can be `null`; however, `Symfony\Component\Routing\RouteCollection::add()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
61			}
62			}
63
64			/**
65			* Decorates route collection during URL URL generation.
66			* Executed before invoking routing enhancers.
67			*
68			* @param RouteCollection $collection
69			* @param array $parameters query parameters
70			*/
71			public function decorateForGeneration(RouteCollection $collection, array $parameters): void
72			{
73			}
74
75			/**
76			* @param AspectInterface[] $aspects
77			*/
78			public function setAspects(array $aspects): void
79			{
80			}
81
82			/**
83			* @return AspectInterface[]
84			*/
85			public function getAspects(): array
86			{
87			return [];
88			}
89
90			private function isRestlerUrl($uri): bool
91			{
92			return \Aoe\Restler\System\Restler\Routes::containsUrl($uri);
93			}
94
95			}
96

AOEpeople / TYPO3_Restler

Pull Request — master (#45)

RestlerEnhancer::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like