Arcanedev\RouteViewer\RouteViewer

Complexity

Total Complexity

7

Size/Duplication

Total Lines	124
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	all()	0	13	2
A	getExcludedUris()	0	4	1
A	getExcludedMethods()	0	4	1
A	getMethodColors()	0	11	1
A	getConfig()	0	4	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 <arcanedev.maroc@gmail.com>
 */
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;

$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?

        $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);
    }
}