Group::getNamePrefix() - Code Metrics - Inspection of "Fix auto response options" - yiisoft/router - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#134)

by Rustam

created 2021-12-16 16:14 UTC

Group::getNamePrefix() A

↳ Parent: Group

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Yiisoft\Router;

use InvalidArgumentException;
use RuntimeException;
use Yiisoft\Middleware\Dispatcher\MiddlewareDispatcher;

use function get_class;
use function in_array;
use function is_object;

final class Group implements GroupInterface
{
    /**
     * @var Group[]|Route[]
     */
    private array $items = [];
    private ?string $prefix;
    private array $middlewareDefinitions = [];
    private ?string $host = null;
    private ?string $namePrefix = null;
    private bool $routesAdded = false;
    private bool $middlewareAdded = false;
    private array $disabledMiddlewareDefinitions = [];
    private array $corsMiddlewares = [];
    private ?MiddlewareDispatcher $dispatcher;

    private function __construct(?string $prefix = null, MiddlewareDispatcher $dispatcher = null)
    {
        $this->dispatcher = $dispatcher;
        $this->prefix = $prefix;
    }

    /**
     * Create a new group instance.
     *
     * @param string|null $prefix URL prefix to prepend to all routes of the group.
     * @param MiddlewareDispatcher|null $dispatcher Middleware dispatcher to use for the group.
     *
     * @return GroupInterface
     */
    public static function create(
        ?string $prefix = null,
        MiddlewareDispatcher $dispatcher = null
    ): GroupInterface {
        return new self($prefix, $dispatcher);
    }

    public function routes(...$routes): GroupInterface
    {
        if ($this->middlewareAdded) {
            throw new RuntimeException('routes() can not be used after prependMiddleware().');
        }
        $new = clone $this;
        foreach ($routes as $route) {
            if ($route instanceof Route || $route instanceof self) {
                if (!$route->hasDispatcher() && $new->hasDispatcher()) {
                    $route = $route->withDispatcher($new->dispatcher);
                }
                $new->items[] = $route;
            } else {
                $type = is_object($route) ? get_class($route) : gettype($route);
                throw new InvalidArgumentException(
                    sprintf('Route should be either an instance of Route or Group, %s given.', $type)
                );
            }
        }

        $new->routesAdded = true;

        return $new;
    }

    public function withDispatcher(MiddlewareDispatcher $dispatcher): GroupInterface
    {
        $group = clone $this;
        $group->dispatcher = $dispatcher;
        foreach ($group->items as $index => $item) {
            if (!$item->hasDispatcher()) {
                $item = $item->withDispatcher($dispatcher);
                $group->items[$index] = $item;
            }
        }

        return $group;
    }

    public function withCors($middlewareDefinition): GroupInterface
    {
        $group = clone $this;
        $group->corsMiddlewares[] = $middlewareDefinition;

        return $group;
    }

    /**
     * Returns the middleware definitions used by the group for CORS.
     *
     * @return array
     */
    public function getCorsMiddlewares(): array
    {
        return $this->corsMiddlewares;
    }

    /**
     * @return bool Whether the group has CORS middleware.
     */
    public function hasCorsMiddlewares(): bool
    {
        return $this->corsMiddlewares !== [];
    }

    public function hasDispatcher(): bool
    {
        return $this->dispatcher !== null;
    }

    public function middleware($middlewareDefinition): GroupInterface
    {
        if ($this->routesAdded) {
            throw new RuntimeException('middleware() can not be used after routes().');
        }
        $new = clone $this;
        array_unshift($new->middlewareDefinitions, $middlewareDefinition);
        return $new;
    }

    public function prependMiddleware($middlewareDefinition): GroupInterface
    {
        $new = clone $this;
        $new->middlewareDefinitions[] = $middlewareDefinition;
        $new->middlewareAdded = true;
        return $new;
    }

    public function namePrefix(string $namePrefix): GroupInterface
    {
        $new = clone $this;
        $new->namePrefix = $namePrefix;
        return $new;
    }

    public function host(string $host): GroupInterface
    {
        $new = clone $this;
        $new->host = rtrim($host, '/');
        return $new;
    }

    public function disableMiddleware($middlewareDefinition): GroupInterface
    {
        $new = clone $this;
        $new->disabledMiddlewareDefinitions[] = $middlewareDefinition;
        return $new;
    }

    /**
     * @return Group[]|Route[]
     */
    public function getItems(): array
    {
        return $this->items;
    }

    public function getPrefix(): ?string
    {
        return $this->prefix;
    }

    public function getNamePrefix(): ?string
    {
        return $this->namePrefix;
    }

    public function getHost(): ?string
    {
        return $this->host;
    }

    public function getMiddlewareDefinitions(): array
    {
        foreach ($this->middlewareDefinitions as $index => $definition) {
            if (in_array($definition, $this->disabledMiddlewareDefinitions, true)) {
                unset($this->middlewareDefinitions[$index]);
            }
        }

        return $this->middlewareDefinitions;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Router;
6
7		use InvalidArgumentException;
8		use RuntimeException;
9		use Yiisoft\Middleware\Dispatcher\MiddlewareDispatcher;
10
11		use function get_class;
12		use function in_array;
13		use function is_object;
14
15		final class Group implements GroupInterface
16		{
17		/**
18		* @var Group[]\|Route[]
19		*/
20		private array $items = [];
21		private ?string $prefix;
22		private array $middlewareDefinitions = [];
23		private ?string $host = null;
24		private ?string $namePrefix = null;
25		private bool $routesAdded = false;
26		private bool $middlewareAdded = false;
27		private array $disabledMiddlewareDefinitions = [];
28		private array $corsMiddlewares = [];
29		private ?MiddlewareDispatcher $dispatcher;
30
31	26	private function __construct(?string $prefix = null, MiddlewareDispatcher $dispatcher = null)
32		{
33	26	$this->dispatcher = $dispatcher;
34	26	$this->prefix = $prefix;
35	26	}
36
37		/**
38		* Create a new group instance.
39		*
40		* @param string\|null $prefix URL prefix to prepend to all routes of the group.
41		* @param MiddlewareDispatcher\|null $dispatcher Middleware dispatcher to use for the group.
42		*
43		* @return GroupInterface
44		*/
45	26	public static function create(
46		?string $prefix = null,
47		MiddlewareDispatcher $dispatcher = null
48		): GroupInterface {
49	26	return new self($prefix, $dispatcher);
50		}
51
52	23	public function routes(...$routes): GroupInterface
53		{
54	23	if ($this->middlewareAdded) {
55	1	throw new RuntimeException('routes() can not be used after prependMiddleware().');
56		}
57	22	$new = clone $this;
58	22	foreach ($routes as $route) {
59	22	if ($route instanceof Route \|\| $route instanceof self) {
60	21	if (!$route->hasDispatcher() && $new->hasDispatcher()) {
61	5	$route = $route->withDispatcher($new->dispatcher);
62		}
63	21	$new->items[] = $route;
64		} else {
65	1	$type = is_object($route) ? get_class($route) : gettype($route);
66	1	throw new InvalidArgumentException(
67	1	sprintf('Route should be either an instance of Route or Group, %s given.', $type)
68		);
69		}
70		}
71
72	21	$new->routesAdded = true;
73
74	21	return $new;
75		}
76
77	2	public function withDispatcher(MiddlewareDispatcher $dispatcher): GroupInterface
78		{
79	2	$group = clone $this;
80	2	$group->dispatcher = $dispatcher;
81	2	foreach ($group->items as $index => $item) {
82	2	if (!$item->hasDispatcher()) {
83	2	$item = $item->withDispatcher($dispatcher);
84	2	$group->items[$index] = $item;
85		}
86		}
87
88	2	return $group;
89		}
90
91	5	public function withCors($middlewareDefinition): GroupInterface
92		{
93	5	$group = clone $this;
94	5	$group->corsMiddlewares[] = $middlewareDefinition;
95
96	5	return $group;
97		}
98
99		/**
100		* Returns the middleware definitions used by the group for CORS.
101		*
102		* @return array
103		*/
104	5	public function getCorsMiddlewares(): array
105		{
106	5	return $this->corsMiddlewares;
107		}
108
109		/**
110		* @return bool Whether the group has CORS middleware.
111		*/
112	18	public function hasCorsMiddlewares(): bool
113		{
114	18	return $this->corsMiddlewares !== [];
115		}
116
117	21	public function hasDispatcher(): bool
118		{
119	21	return $this->dispatcher !== null;
120		}
121
122	7	public function middleware($middlewareDefinition): GroupInterface
123		{
124	7	if ($this->routesAdded) {
125		throw new RuntimeException('middleware() can not be used after routes().');
126		}
127	7	$new = clone $this;
128	7	array_unshift($new->middlewareDefinitions, $middlewareDefinition);
129	7	return $new;
130		}
131
132	3	public function prependMiddleware($middlewareDefinition): GroupInterface
133		{
134	3	$new = clone $this;
135	3	$new->middlewareDefinitions[] = $middlewareDefinition;
136	3	$new->middlewareAdded = true;
137	3	return $new;
138		}
139
140	3	public function namePrefix(string $namePrefix): GroupInterface
141		{
142	3	$new = clone $this;
143	3	$new->namePrefix = $namePrefix;
144	3	return $new;
145		}
146
147	2	public function host(string $host): GroupInterface
148		{
149	2	$new = clone $this;
150	2	$new->host = rtrim($host, '/');
151	2	return $new;
152		}
153
154		public function disableMiddleware($middlewareDefinition): GroupInterface
155		{
156		$new = clone $this;
157		$new->disabledMiddlewareDefinitions[] = $middlewareDefinition;
158		return $new;
159		}
160
161		/**
162		* @return Group[]\|Route[]
163		*/
164	20	public function getItems(): array
165		{
166	20	return $this->items;
167		}
168
169	19	public function getPrefix(): ?string
170		{
171	19	return $this->prefix;
172		}
173
174	19	public function getNamePrefix(): ?string
175		{
176	19	return $this->namePrefix;
177		}
178
179	19	public function getHost(): ?string
180		{
181	19	return $this->host;
182		}
183
184	16	public function getMiddlewareDefinitions(): array
185		{
186	16	foreach ($this->middlewareDefinitions as $index => $definition) {
187	8	if (in_array($definition, $this->disabledMiddlewareDefinitions, true)) {
188		unset($this->middlewareDefinitions[$index]);
189		}
190		}
191
192	16	return $this->middlewareDefinitions;
193		}
194		}
195

yiisoft / router

Pull Request — master (#134)

Group::getNamePrefix() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like