RouteViewer::__construct() - Code Metrics - ARCANEDEV/RouteViewer - Measure and Improve Code Quality continuously with Scrutinizer

RouteViewer::__construct() A
last analyzed 2020-09-10 09:39 UTC

↳ Parent: RouteViewer

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Arcanedev\RouteViewer;

use Arcanedev\RouteViewer\Contracts\RouteViewer as RouteViewerContract;
use Illuminate\Contracts\Config\Repository as Config;
use Illuminate\Contracts\Routing\Registrar as Router;

/**
 * Class     RouteViewer
 *
 * @author   ARCANEDEV <[email protected]>
 */
class RouteViewer implements RouteViewerContract
{
    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /**
     * The router instance.
     *
     * @var  \Illuminate\Routing\Router
     */
    private $router;

    /**
     * The config repository.
     *
     * @var \Illuminate\Contracts\Config\Repository
     */
    private $config;

    /**
     * The route collection.
     *
     * @var \Arcanedev\RouteViewer\Entities\RouteCollection
     */
    protected $routes;

    /* -----------------------------------------------------------------
     |  Constructor
     | -----------------------------------------------------------------
     */

    /**
     * RouteViewer constructor.
     *
     * @param  \Illuminate\Contracts\Routing\Registrar  $router
     * @param  \Illuminate\Contracts\Config\Repository  $config
     */
    public function __construct(Router $router, Config $config)
    {
        $this->router = $router;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
        $this->config = $config;
    }

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Get all routes.
     *
     * @return \Arcanedev\RouteViewer\Entities\RouteCollection
     */
    public function all()
    {
        if (is_null($this->routes)) {
            $this->routes = Entities\RouteCollection::load(
                $this->router->getRoutes()->getRoutes(),
                $this->getExcludedUris(),
                $this->getExcludedMethods(),
                $this->getMethodColors()
            );
        }

        return $this->routes;
    }

    /**
     * Get the excluded URIs.
     *
     * @return array
     */
    public function getExcludedUris(): array
    {
        return $this->getConfig('uris.excluded', []);
    }

    /**
     * Get the excluded methods.
     *
     * @return array
     */
    public function getExcludedMethods(): array
    {
        return $this->getConfig('methods.excluded', ['HEAD']);
    }

    /**
     * Get method colors.
     *
     * @return array
     */
    private function getMethodColors(): array
    {
        return $this->getConfig('methods.colors', [
            'GET'    => 'success',
            'HEAD'   => 'default',
            'POST'   => 'primary',
            'PUT'    => 'warning',
            'PATCH'  => 'info',
            'DELETE' => 'danger',
        ]);
    }

    /* -----------------------------------------------------------------
     |  Other Methods
     | -----------------------------------------------------------------
     */

    /**
     * Get a config value.
     *
     * @param  string      $key
     * @param  mixed|null  $default
     *
     * @return mixed
     */
    private function getConfig(string $key, $default = null)
    {
        return $this->config->get("route-viewer.{$key}", $default);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Arcanedev\RouteViewer;
6
7		use Arcanedev\RouteViewer\Contracts\RouteViewer as RouteViewerContract;
8		use Illuminate\Contracts\Config\Repository as Config;
9		use Illuminate\Contracts\Routing\Registrar as Router;
10
11		/**
12		* Class RouteViewer
13		*
14		* @author ARCANEDEV <[email protected]>
15		*/
16		class RouteViewer implements RouteViewerContract
17		{
18		/* -----------------------------------------------------------------
19		\| Properties
20		\| -----------------------------------------------------------------
21		*/
22
23		/**
24		* The router instance.
25		*
26		* @var \Illuminate\Routing\Router
27		*/
28		private $router;
29
30		/**
31		* The config repository.
32		*
33		* @var \Illuminate\Contracts\Config\Repository
34		*/
35		private $config;
36
37		/**
38		* The route collection.
39		*
40		* @var \Arcanedev\RouteViewer\Entities\RouteCollection
41		*/
42		protected $routes;
43
44		/* -----------------------------------------------------------------
45		\| Constructor
46		\| -----------------------------------------------------------------
47		*/
48
49		/**
50		* RouteViewer constructor.
51		*
52		* @param \Illuminate\Contracts\Routing\Registrar $router
53		* @param \Illuminate\Contracts\Config\Repository $config
54		*/
55	12	public function __construct(Router $router, Config $config)
56		{
57	12	$this->router = $router;
		0 ignored issues – show Documentation Bug introduced 2016-12-24 19:23 UTC by Report Bug Copy Issue Report `$router` is of type `object<Illuminate\Contracts\Routing\Registrar>`, but the property `$router` was declared to be of type `object<Illuminate\Routing\Router>`. Are you sure that you always receive this specific sub-class here, or does it make sense to add an `instanceof` check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
58	12	$this->config = $config;
59	12	}
60
61		/* -----------------------------------------------------------------
62		\| Main Methods
63		\| -----------------------------------------------------------------
64		*/
65
66		/**
67		* Get all routes.
68		*
69		* @return \Arcanedev\RouteViewer\Entities\RouteCollection
70		*/
71	8	public function all()
72		{
73	8	if (is_null($this->routes)) {
74	8	$this->routes = Entities\RouteCollection::load(
75	8	$this->router->getRoutes()->getRoutes(),
76	8	$this->getExcludedUris(),
77	8	$this->getExcludedMethods(),
78	8	$this->getMethodColors()
79		);
80		}
81
82	8	return $this->routes;
83		}
84
85		/**
86		* Get the excluded URIs.
87		*
88		* @return array
89		*/
90	8	public function getExcludedUris(): array
91		{
92	8	return $this->getConfig('uris.excluded', []);
93		}
94
95		/**
96		* Get the excluded methods.
97		*
98		* @return array
99		*/
100	8	public function getExcludedMethods(): array
101		{
102	8	return $this->getConfig('methods.excluded', ['HEAD']);
103		}
104
105		/**
106		* Get method colors.
107		*
108		* @return array
109		*/
110	8	private function getMethodColors(): array
111		{
112	8	return $this->getConfig('methods.colors', [
113	8	'GET' => 'success',
114		'HEAD' => 'default',
115		'POST' => 'primary',
116		'PUT' => 'warning',
117		'PATCH' => 'info',
118		'DELETE' => 'danger',
119		]);
120		}
121
122		/* -----------------------------------------------------------------
123		\| Other Methods
124		\| -----------------------------------------------------------------
125		*/
126
127		/**
128		* Get a config value.
129		*
130		* @param string $key
131		* @param mixed\|null $default
132		*
133		* @return mixed
134		*/
135	8	private function getConfig(string $key, $default = null)
136		{
137	8	return $this->config->get("route-viewer.{$key}", $default);
138		}
139		}
140

ARCANEDEV / RouteViewer

RouteViewer::__construct() A last analyzed 2020-09-10 09:39 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

RouteViewer::__construct() A
last analyzed 2020-09-10 09:39 UTC