Arcanedev\RouteViewer\Entities\Route

Complexity

Total Complexity

13

Size/Duplication

Total Lines	185
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	setUri()	0	9	1
A	getActionNamespace()	0	4	2
A	getActionMethod()	0	4	2
A	hasName()	0	4	1
A	hasDomain()	0	4	1
A	hasMiddleware()	0	4	1
A	isClosure()	0	4	1
A	toArray()	0	12	1
A	jsonSerialize()	0	4	1
A	toJson()	0	4	1

<?php

declare(strict_types=1);

namespace Arcanedev\RouteViewer\Entities;

use Illuminate\Contracts\Support\{Arrayable, Jsonable};
use JsonSerializable;

/**
 * Class     Route
 *
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
class Route implements Arrayable, Jsonable, JsonSerializable
{
    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /** @var array */
    public $methods = [];

    /** @var string */
    public $uri;

    /** @var array */
    public $params = [];

    /** @var string */
    public $action;

    /** @var string */
    public $name;

    /** @var array */
    public $middleware;

    /** @var string|null */
    public $domain;

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

    /**
     * Route constructor.
     *
     * @param  array        $methods
     * @param  string       $uri
     * @param  string|null  $name
     * @param  string|null  $action
     * @param  array        $middleware
     * @param  string|null  $domain
     */
    public function __construct(array $methods, $uri, $action, $name, array $middleware, $domain = null)
    {
        $this->methods    = $methods;
        $this->setUri($uri);
        $this->action     = $action;
        $this->name       = $name;
        $this->middleware = $middleware;
        $this->domain     = $domain;
    }

    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Set the route URI.
     *
     * @param  string  $uri
     *
     * @return $this
     */
    private function setUri(string $uri)
    {
        $this->uri = $uri;

        preg_match_all('/({[^}]+})/', $this->uri, $matches);
        $this->params = $matches[0];

        return $this;
    }

    /**
     * Get the action namespace.
     *
     * @return string
     */
    public function getActionNamespace(): string
    {
        return $this->isClosure() ? '' : explode('@', $this->action)[0];
    }

    /**
     * Get the action method.
     *
     * @return string
     */
    public function getActionMethod(): string
    {
        return $this->isClosure() ? '' : explode('@', $this->action)[1];
    }

    /* -----------------------------------------------------------------
     |  Check Methods
     | -----------------------------------------------------------------
     */

    /**
     * Check if the route has name.
     *
     * @return bool
     */
    public function hasName(): bool
    {
        return ! is_null($this->name);
    }

    /**
     * Check if the route has domain.
     *
     * @return bool
     */
    public function hasDomain(): bool
    {
        return ! is_null($this->domain);
    }

    /**
     * Check if the route has middleware.
     *
     * @return bool
     */
    public function hasMiddleware(): bool
    {
        return ! empty($this->middleware);
    }

    /**
     * Check if the action is a closure function.
     *
     * @return bool
     */
    public function isClosure(): bool
    {
        return $this->action === 'Closure';
    }

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

    /**
     * Get the instance as an array.
     *
     * @return array
     */
    public function toArray(): array
    {
        return [
            'methods'    => $this->methods,
            'uri'        => $this->uri,
            'params'     => $this->params,
            'action'     => $this->action,
            'name'       => $this->name,
            'middleware' => $this->middleware,
            'domain'     => $this->domain,
        ];
    }

    /**
     * Convert the object into something JSON serializable.
     *
     * @return array
     */
    public function jsonSerialize(): array
    {
        return $this->toArray();
    }

    /**
     * Convert the object to its JSON representation.
     *
     * @param  int  $options
     *
     * @return string
     */
    public function toJson($options = 0): string
    {
        return json_encode($this->jsonSerialize(), $options);
    }
}