MinasRouter\Traits\RouteManagerUtils

Complexity

Total Complexity

11

Size/Duplication

Total Lines	130
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	whereAlpha()	0	3	1
A	as()	0	3	1
A	whereParam()	0	5	1
A	whereAlphaNumeric()	0	3	1
A	whereNumber()	0	3	1
A	whereUuid()	0	3	1
A	where()	0	7	1
A	name()	0	9	2
A	withoutMiddleware()	0	10	2

<?php

namespace MinasRouter\Traits;

use MinasRouter\Router\Middlewares\MiddlewareCollection;

trait RouteManagerUtils
{
    public abstract function getDefaultName();
    public abstract function setName(String $name);
    public abstract function setWhereData(String $key, String $value);

    /**
     * Method responsible for defining the regular
     * expressions of dynamic parameters.
     * 
     * @param array $matches
     * 
     */
    public function where(array $matches)
    {
        array_map(function ($key, $value) {
            $this->setWhereData($key, $value);
        }, array_keys($matches), $matches);

        return $this;
    }

    /**
     * Alias of the where method, but only for one parameter
     * 
     * @param string $param
     * @param string $value
     * 
     */
    public function whereParam(String $param, String $value)
    {
        $this->setWhereData($param, $value);

        return $this;
    }

    /**
     * Method responsible for defining a
     * dynamic parameter as a number.
     * 
     * @param string $param
     * 
     */
    public function whereNumber(String $param)
    {
        return $this->whereParam($param, "[0-9]+");
    }

    /**
     * Method responsible for defining a
     * dynamic parameter as alpha characters.
     * 
     * @param string $param
     * 
     */
    public function whereAlpha(String $param)
    {
        return $this->whereParam($param, "[a-zA-ZÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÒÓÔÕÖßÙÚÛÜÝŸÑàáâãäåçèéêëìíîïðòóôõöùúûüýÿñ]+");
    }

    /**
     * Method responsible for defining a
     * dynamic parameter as alpha numeric.
     * 
     * @param string $param
     * 
     */
    public function whereAlphaNumeric(String $param)
    {
        return $this->whereParam($param, "[a-zA-ZÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÒÓÔÕÖßÙÚÛÜÝŸÑàáâãäåçèéêëìíîïðòóôõöùúûüýÿñ0-9]+");
    }

    /**
     * Method responsible for defining a
     * dynamic parameter as alpha numeric.
     * 
     * @param string $param
     * 
     */
    public function whereUuid(String $param)
    {
        return $this->whereParam($param, "(?i)[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}");
    }

    /**
     * Set the name of route. The second parameter
     * when true will ignore the group prefix.
     * 
     * @param string $name
     * @param bool $ignoreDefault
     * 
     */
    public function name(String $name, Bool $ignoreDefault = false)
    {
        if($ignoreDefault) {
            $this->setName($name);
        } else {
            $this->setName($this->getDefaultName() . $name);
        }

        return $this;
    }

    /**
     * Alias of the name method.
     * 
     * @param string $name
     * 
     */
    public function as(String $name)
    {
        return $this->name($name);
    }

    /**
     * Remove a group middleware of the route
     * 
     * @param string|array $middleware
     * 
     */
    public function withoutMiddleware($middleware)
    {
        if(!is_a($this->middleware, MiddlewareCollection::class)) {
            return;
        }

        $this->middleware = clone $this->middleware;

The property middleware does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->middleware->removeMiddleware($middleware);

        return $this;
    }
}