Group::getHost() - Code Metrics - Inspection of "Split group" - yiisoft/router - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#115)

by Rustam

created 2021-07-21 10:07 UTC

Group::getHost() 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
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10

<?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_array;
use function is_callable;
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 ?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().');
        }
        if (is_callable($routes)) {
            $callback = $routes;
        } elseif (is_array($routes)) {

            $callback = static function (self $group) use (&$routes) {
                foreach ($routes as $route) {
                    if ($route instanceof Route || $route instanceof self) {
                        if (!$route->hasDispatcher() && $group->hasDispatcher()) {
                            $route = $route->withDispatcher($group->dispatcher);
                        }
                        $group->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)
                        );
                    }
                }
            };
        } else {
            $callback = null;
        }

        $new = clone $this;
        if ($callback !== null) {

            $callback($new);
        }
        $new->routesAdded = true;

        return $new;
    }

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

        return $group;
    }

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

    /**
     * Appends a handler middleware definition that should be invoked for a matched route.
     * First added handler will be executed first.
     *
     * @param mixed $middlewareDefinition
     *
     * @return self
     */
    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;
    }

    /**
     * Prepends a handler middleware definition that should be invoked for a matched route.
     * First added handler will be executed last.
     *
     * @param mixed $middlewareDefinition
     *
     * @return self
     */
    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;
    }

    /**
     * Excludes middleware from being invoked when action is handled.
     * It is useful to avoid invoking one of the parent group middleware for
     * a certain route.
     *
     * @param mixed $middlewareDefinition
     *
     * @return self
     */
    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_array;
14		use function is_callable;
15		use function is_object;
16
17		final class Group implements GroupInterface
18		{
19		/**
20		* @var Group[]\|Route[]
21		*/
22		private array $items = [];
23		private ?string $prefix;
24		private array $middlewareDefinitions = [];
25		private ?string $host = null;
26		private ?string $namePrefix = null;
27		private bool $routesAdded = false;
28		private bool $middlewareAdded = false;
29		private array $disabledMiddlewareDefinitions = [];
30		private ?MiddlewareDispatcher $dispatcher;
31
32	14	private function __construct(?string $prefix = null, MiddlewareDispatcher $dispatcher = null)
33		{
34	14	$this->dispatcher = $dispatcher;
35	14	$this->prefix = $prefix;
36	14	}
37
38		/**
39		* Create a new group instance.
40		*
41		* @param string\|null $prefix URL prefix to prepend to all routes of the group.
42		* @param MiddlewareDispatcher\|null $dispatcher Middleware dispatcher to use for the group.
43		*
44		* @return GroupInterface
45		*/
46	14	public static function create(
47		?string $prefix = null,
48		MiddlewareDispatcher $dispatcher = null
49		): GroupInterface {
50	14	return new self($prefix, $dispatcher);
51		}
52
53	11	public function routes(...$routes): GroupInterface
54		{
55	11	if ($this->middlewareAdded) {
56		throw new RuntimeException('routes() can not be used after prependMiddleware().');
57		}
58	11	if (is_callable($routes)) {
59		$callback = $routes;
60	11	} elseif (is_array($routes)) {
		0 ignored issues – show introduced 2021-05-12 05:35 UTC by Report Bug Copy Issue Report The condition `is_array($routes)` is always `true`. Loading history...
61	11	$callback = static function (self $group) use (&$routes) {
62	11	foreach ($routes as $route) {
63	11	if ($route instanceof Route \|\| $route instanceof self) {
64	11	if (!$route->hasDispatcher() && $group->hasDispatcher()) {
65	4	$route = $route->withDispatcher($group->dispatcher);
66		}
67	11	$group->items[] = $route;
68		} else {
69		$type = is_object($route) ? get_class($route) : gettype($route);
70		throw new InvalidArgumentException(
71		sprintf('Route should be either an instance of Route or Group, %s given.', $type)
72		);
73		}
74		}
75	11	};
76		} else {
77		$callback = null;
78		}
79
80	11	$new = clone $this;
81	11	if ($callback !== null) {
		0 ignored issues – show introduced 2021-05-12 05:35 UTC by Report Bug Copy Issue Report The condition `$callback !== null` is always `true`. Loading history...
82	11	$callback($new);
83		}
84	11	$new->routesAdded = true;
85
86	11	return $new;
87		}
88
89	2	public function withDispatcher(MiddlewareDispatcher $dispatcher): GroupInterface
90		{
91	2	$group = clone $this;
92	2	$group->dispatcher = $dispatcher;
93	2	foreach ($group->items as $index => $route) {
94	2	if (!$route->hasDispatcher()) {
95	2	$route = $route->withDispatcher($dispatcher);
96	2	$group->items[$index] = $route;
97		}
98		}
99
100	2	return $group;
101		}
102
103	11	public function hasDispatcher(): bool
104		{
105	11	return $this->dispatcher !== null;
106		}
107
108		/**
109		* Appends a handler middleware definition that should be invoked for a matched route.
110		* First added handler will be executed first.
111		*
112		* @param mixed $middlewareDefinition
113		*
114		* @return self
115		*/
116	6	public function middleware($middlewareDefinition): GroupInterface
117		{
118	6	if ($this->routesAdded) {
119		throw new RuntimeException('middleware() can not be used after routes().');
120		}
121	6	$new = clone $this;
122	6	array_unshift($new->middlewareDefinitions, $middlewareDefinition);
123	6	return $new;
124		}
125
126		/**
127		* Prepends a handler middleware definition that should be invoked for a matched route.
128		* First added handler will be executed last.
129		*
130		* @param mixed $middlewareDefinition
131		*
132		* @return self
133		*/
134	1	public function prependMiddleware($middlewareDefinition): GroupInterface
135		{
136	1	$new = clone $this;
137	1	$new->middlewareDefinitions[] = $middlewareDefinition;
138	1	$new->middlewareAdded = true;
139	1	return $new;
140		}
141
142	2	public function namePrefix(string $namePrefix): GroupInterface
143		{
144	2	$new = clone $this;
145	2	$new->namePrefix = $namePrefix;
146	2	return $new;
147		}
148
149	2	public function host(string $host): GroupInterface
150		{
151	2	$new = clone $this;
152	2	$new->host = rtrim($host, '/');
153	2	return $new;
154		}
155
156		/**
157		* Excludes middleware from being invoked when action is handled.
158		* It is useful to avoid invoking one of the parent group middleware for
159		* a certain route.
160		*
161		* @param mixed $middlewareDefinition
162		*
163		* @return self
164		*/
165		public function disableMiddleware($middlewareDefinition): GroupInterface
166		{
167		$new = clone $this;
168		$new->disabledMiddlewareDefinitions[] = $middlewareDefinition;
169		return $new;
170		}
171
172		/**
173		* @return Group[]\|Route[]
174		*/
175	10	public function getItems(): array
176		{
177	10	return $this->items;
178		}
179
180	9	public function getPrefix(): ?string
181		{
182	9	return $this->prefix;
183		}
184
185	9	public function getNamePrefix(): ?string
186		{
187	9	return $this->namePrefix;
188		}
189
190	9	public function getHost(): ?string
191		{
192	9	return $this->host;
193		}
194
195	8	public function getMiddlewareDefinitions(): array
196		{
197	8	foreach ($this->middlewareDefinitions as $index => $definition) {
198	6	if (in_array($definition, $this->disabledMiddlewareDefinitions, true)) {
199		unset($this->middlewareDefinitions[$index]);
200		}
201		}
202
203	8	return $this->middlewareDefinitions;
204		}
205		}
206

yiisoft / router

Pull Request — master (#115)

Group::getHost() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like