RoutesSet::getRouteByName() - Code Metrics - Inspection of "feature/Method reverse was added, unit-tests were..." - alexdodonov/mezon-router - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2dfe17...2fbb48 )

by Alex

created 2020-06-03 09:15 UTC

RoutesSet::getRouteByName() A

↳ Parent: RoutesSet

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	3
nc	2
nop	1
dl	0
loc	7
rs	10
c	0
b	0
f	0

<?php
namespace Mezon\Router;

trait RoutesSet
{

    /**
     * List off routes for all supported request methods
     */
    private $routes = [
        'GET' => [],
        'POST' => [],
        'PUT' => [],
        'DELETE' => [],
        'OPTION' => []
    ];

    /**
     * Route names
     *
     * @var array
     */
    private $routeNames = [];

    /**
     * This flag rises when we add route / * /
     *
     * @var bool
     */
    protected $universalRouteWasAdded = false;

    /**
     * Validating that request method is supported within this router.
     * If it is not supported then Exception will be thrown
     *
     * @param string $requestMethod
     *            request method
     */
    protected function validateSupportedRequestMethod(string $requestMethod): void
    {
        if (isset($this->routes[$requestMethod]) === false) {
            throw (new \Exception('Unsupported request method'));
        }
    }

    /**
     * Method returns list of routes for the HTTP method.
     *
     * @param string $requestMethod
     *            HTTP request method
     * @return array Routes
     */
    protected function &getRoutesForMethod(string $requestMethod): array
    {
        $this->validateSupportedRequestMethod($requestMethod);

        return $this->routes[$requestMethod];
    }

    /**
     * Method returns a list of supported request methods
     *
     * @return array list of supported request methods
     */
    public function getListOfSupportedRequestMethods(): array
    {
        return [
            'GET',
            'POST',
            'PUT',
            'DELETE',
            'OPTION'
        ];
    }

    /**
     * Method clears router data.
     */
    public function clear()
    {
        $this->universalRouteWasAdded = false;

        $this->routeNames = [];

        foreach ($this->getListOfSupportedRequestMethods() as $requestMethod) {
            $this->routes[$requestMethod] = [];
        }
    }

    /**
     * Method returns true if the router exists
     *
     * @param string $route
     *            checking route
     * @return bool true if the router exists, false otherwise
     */
    public function routeExists(string $route): bool
    {
        $route = trim($route, '/');

        foreach ($this->getListOfSupportedRequestMethods() as $requestMethod) {
            if (isset($this->routes[$requestMethod][$route])) {
                return true;
            }
        }

        return false;
    }

    /**
     * Method rturns all available routes
     */
    public function getAllRoutesTrace()
    {
        $trace = [];

        foreach ($this->getListOfSupportedRequestMethods() as $requestMethod) {
            if (count($this->routes[$requestMethod]) > 0) {
                $trace[] = $requestMethod . ':' . implode(', ', array_keys($this->routes[$requestMethod]));
            }
        }

        return implode('; ', $trace);
    }

    /**
     * Additing route for GET request
     *
     * @param string $route
     *            route
     * @param object $object
     *            callback object
     * @param string $method
     *            callback method
     */
    public function addGetRoute(string $route, object $object, string $method): void
    {
        $this->routes['GET'][trim($route, '/')] = [
            $object,
            $method
        ];
    }

    /**
     * Additing route for GET request
     *
     * @param string $route
     *            route
     * @param object $object
     *            callback object
     * @param string $method
     *            callback method
     */
    public function addPostRoute(string $route, object $object, string $method): void
    {
        $this->routes['POST'][trim($route, '/')] = [
            $object,
            $method
        ];
    }

    /**
     * Method registers name of the route
     *
     * @param string $routeName
     *            route's name
     * @param string $route
     *            route
     */
    protected function registerRouteName(string $routeName, string $route): void
    {
        if ($routeName != '') {
            $this->routeNames[$routeName] = $route;
        }
    }

    /**
     * Validating that route name exists
     *
     * @param string $routeName
     * @return bool
     */
    protected function routeNameExists(string $routeName): bool
    {
        return isset($this->routeNames[$routeName]);
    }

    /**
     * Getting route by name
     *
     * @param string $routeName
     *            route's name
     * @return string route
     */
    public function getRouteByName(string $routeName): string
    {
        if ($this->routeNameExists($routeName) === false) {
            throw (new \Exception('Route with name ' . $routeName . ' does not exist'));
        }

        return $this->routeNames[$routeName];
    }
}


1			<?php
2			namespace Mezon\Router;
3
4			trait RoutesSet
5			{
6
7			/**
8			* List off routes for all supported request methods
9			*/
10			private $routes = [
11			'GET' => [],
12			'POST' => [],
13			'PUT' => [],
14			'DELETE' => [],
15			'OPTION' => []
16			];
17
18			/**
19			* Route names
20			*
21			* @var array
22			*/
23			private $routeNames = [];
24
25			/**
26			* This flag rises when we add route / * /
27			*
28			* @var bool
29			*/
30			protected $universalRouteWasAdded = false;
31
32			/**
33			* Validating that request method is supported within this router.
34			* If it is not supported then Exception will be thrown
35			*
36			* @param string $requestMethod
37			* request method
38			*/
39			protected function validateSupportedRequestMethod(string $requestMethod): void
40			{
41			if (isset($this->routes[$requestMethod]) === false) {
42			throw (new \Exception('Unsupported request method'));
43			}
44			}
45
46			/**
47			* Method returns list of routes for the HTTP method.
48			*
49			* @param string $requestMethod
50			* HTTP request method
51			* @return array Routes
52			*/
53			protected function &getRoutesForMethod(string $requestMethod): array
54			{
55			$this->validateSupportedRequestMethod($requestMethod);
56
57			return $this->routes[$requestMethod];
58			}
59
60			/**
61			* Method returns a list of supported request methods
62			*
63			* @return array list of supported request methods
64			*/
65			public function getListOfSupportedRequestMethods(): array
66			{
67			return [
68			'GET',
69			'POST',
70			'PUT',
71			'DELETE',
72			'OPTION'
73			];
74			}
75
76			/**
77			* Method clears router data.
78			*/
79			public function clear()
80			{
81			$this->universalRouteWasAdded = false;
82
83			$this->routeNames = [];
84
85			foreach ($this->getListOfSupportedRequestMethods() as $requestMethod) {
86			$this->routes[$requestMethod] = [];
87			}
88			}
89
90			/**
91			* Method returns true if the router exists
92			*
93			* @param string $route
94			* checking route
95			* @return bool true if the router exists, false otherwise
96			*/
97			public function routeExists(string $route): bool
98			{
99			$route = trim($route, '/');
100
101			foreach ($this->getListOfSupportedRequestMethods() as $requestMethod) {
102			if (isset($this->routes[$requestMethod][$route])) {
103			return true;
104			}
105			}
106
107			return false;
108			}
109
110			/**
111			* Method rturns all available routes
112			*/
113			public function getAllRoutesTrace()
114			{
115			$trace = [];
116
117			foreach ($this->getListOfSupportedRequestMethods() as $requestMethod) {
118			if (count($this->routes[$requestMethod]) > 0) {
119			$trace[] = $requestMethod . ':' . implode(', ', array_keys($this->routes[$requestMethod]));
120			}
121			}
122
123			return implode('; ', $trace);
124			}
125
126			/**
127			* Additing route for GET request
128			*
129			* @param string $route
130			* route
131			* @param object $object
132			* callback object
133			* @param string $method
134			* callback method
135			*/
136			public function addGetRoute(string $route, object $object, string $method): void
137			{
138			$this->routes['GET'][trim($route, '/')] = [
139			$object,
140			$method
141			];
142			}
143
144			/**
145			* Additing route for GET request
146			*
147			* @param string $route
148			* route
149			* @param object $object
150			* callback object
151			* @param string $method
152			* callback method
153			*/
154			public function addPostRoute(string $route, object $object, string $method): void
155			{
156			$this->routes['POST'][trim($route, '/')] = [
157			$object,
158			$method
159			];
160			}
161
162			/**
163			* Method registers name of the route
164			*
165			* @param string $routeName
166			* route's name
167			* @param string $route
168			* route
169			*/
170			protected function registerRouteName(string $routeName, string $route): void
171			{
172			if ($routeName != '') {
173			$this->routeNames[$routeName] = $route;
174			}
175			}
176
177			/**
178			* Validating that route name exists
179			*
180			* @param string $routeName
181			* @return bool
182			*/
183			protected function routeNameExists(string $routeName): bool
184			{
185			return isset($this->routeNames[$routeName]);
186			}
187
188			/**
189			* Getting route by name
190			*
191			* @param string $routeName
192			* route's name
193			* @return string route
194			*/
195			public function getRouteByName(string $routeName): string
196			{
197			if ($this->routeNameExists($routeName) === false) {
198			throw (new \Exception('Route with name ' . $routeName . ' does not exist'));
199			}
200
201			return $this->routeNames[$routeName];
202			}
203			}
204

alexdodonov / mezon-router

Push — master ( 2dfe17...2fbb48 )

RoutesSet::getRouteByName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like