RouterInjectable::addDefault() - Code Metrics - Inspection of "Support different routes per request methods." - canax/router - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9a0f12...ce5c53 )

by Mikael

created 2017-03-13 17:05 UTC

RouterInjectable::addDefault() A

↳ Parent: RouterInjectable

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	6

Duplication

Lines	9
Ratio	100 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	9
loc	9
ccs	6
cts	6
cp	1
rs	9.6666
cc	1
eloc	6
nc	1
nop	1
crap	1

<?php

namespace Anax\Route;

/**
 * A container for routes.
 *
 */
class RouterInjectable
{
    /**
     * Properties
     *
     */
    private $routes         = [];    // All the routes
    private $internalRoutes = [];    // All internal routes
    private $lastRoute      = null;  // Last route that was callbacked



    /**
     * Get all routes.
     *
     * @return array with all routes.
     */
    public function getAll()
    {
        return $this->routes;
    }



    /**
     * Get all internal routes.
     *
     * @return array with internal routes.
     */
    public function getInternal()
    {
        return $this->internalRoutes;
    }



    /**
     * Add a route to the router.
     *
     * @param string $rule   for this route
     * @param mixed  $action null, string or callable to implement a
     *                       controller for the route
     *
     * @return class as new route
     */
    public function add($rule, $action = null)

    {
        $route = new Route();
        $route->set($rule, $action, []);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->routes[] = $route;

        return $route;
    }



    /**
     * Add aroute to the router with specific request method.
     *
     * @param array  $method as array of strings of request methods
     * @param string $rule   for this route
     * @param mixed  $action null, string or callable to implement a
     *                       controller for the route
     *
     * @return class as new route
     */
    public function any($method, $rule, $action = null)

    {
        $route = new Route();
        $route->set($rule, $action, $method);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->routes[] = $route;

        return $route;
    }



    /**
     * Add a GET route to the router.
     *
     * @param string $rule   for this route
     * @param mixed  $action null, string or callable to implement a
     *                       controller for the route
     *
     * @return class as new route
     */
    public function get($rule, $action = null)
    {
        return $this->any(["GET"], $rule, $action);
    }



    /**
     * Add a POST route to the router.
     *
     * @param string $rule   for this route
     * @param mixed  $action null, string or callable to implement a
     *                       controller for the route
     *
     * @return class as new route
     */
    public function post($rule, $action = null)
    {
        return $this->any(["POST"], $rule, $action);
    }



    /**
     * Add a PUT route to the router.
     *
     * @param string $rule   for this route
     * @param mixed  $action null, string or callable to implement a
     *                       controller for the route
     *
     * @return class as new route
     */
    public function put($rule, $action = null)
    {
        return $this->any(["PUT"], $rule, $action);
    }



    /**
     * Add a DELETE route to the router.
     *
     * @param string $rule   for this route
     * @param mixed  $action null, string or callable to implement a
     *                       controller for the route
     *
     * @return class as new route
     */
    public function delete($rule, $action = null)
    {
        return $this->any(["DELETE"], $rule, $action);
    }



    /**
     * Add an internal (not exposed to url-matching) route to the router.
     *
     * @param string $rule   for this route
     * @param mixed  $action null, string or callable to implement a controller for the route
     *
     * @return class as new route
     */
    public function addInternal($rule, $action = null)
    {
        $route = new Route();
        $route->set($rule, $action);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->internalRoutes[$rule] = $route;
        return $route;
    }



    /**
     * Add an internal (not exposed to url-matching) route to the router.
     *
     * @param string $rule   for this route
     * @param mixed  $action null, string or callable to implement a
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *                       controller for the route
     *
     * @return void
     */
    public function handleInternal($rule)
    {
        if (!isset($this->internalRoutes[$rule])) {
            throw new NotFoundException("No internal route to handle: " . $rule);
        }
        $route = $this->internalRoutes[$rule];
        $this->lastRoute = $rule;
        $route->handle();
    }



    /**
     * Get the route for the last route that was handled.
     *
     * @return mixed
     */
    public function getLastRoute()
    {
        return $this->lastRoute;
    }



    /**
     * Handle the routes and match them towards the request, dispatch them
     * when a match is made. Each route handler may throw exceptions that
     * may redirect to an internal route for error handling.
     *
     * @param string $query   the query/route to match a handler for.
     * @param string $method  the request method to match.
     *
     * @return mixed content returned from route.
     */
    public function handle($query, $method = null)
    {
        try {
            // Match predefined routes
            foreach ($this->routes as $route) {
                if ($route->match($query, $method)) {
                    $this->lastRoute = $route->getRule();
                    return $route->handle();
                }
            }

            // No route was matched
            $this->handleInternal("404");
        } catch (ForbiddenException $e) {
            $this->handleInternal("403");
        } catch (NotFoundException $e) {
            $this->handleInternal("404");
        } catch (InternalErrorException $e) {
            $this->handleInternal("500");
        }
    }
}


1			<?php
2
3			namespace Anax\Route;
4
5			/**
6			* A container for routes.
7			*
8			*/
9			class RouterInjectable
10			{
11			/**
12			* Properties
13			*
14			*/
15			private $routes = []; // All the routes
16			private $internalRoutes = []; // All internal routes
17			private $lastRoute = null; // Last route that was callbacked
18
19
20
21			/**
22			* Get all routes.
23			*
24			* @return array with all routes.
25			*/
26			public function getAll()
27			{
28			return $this->routes;
29			}
30
31
32
33			/**
34			* Get all internal routes.
35			*
36			* @return array with internal routes.
37			*/
38			public function getInternal()
39			{
40			return $this->internalRoutes;
41			}
42
43
44
45			/**
46			* Add a route to the router.
47			*
48			* @param string $rule for this route
49			* @param mixed $action null, string or callable to implement a
50			* controller for the route
51			*
52			* @return class as new route
53			*/
54	8	View Code Duplication	public function add($rule, $action = null)
			0 ignored issues – show Duplication introduced 2017-03-07 10:55 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
55			{
56	8		$route = new Route();
57	8		$route->set($rule, $action, []);
			0 ignored issues – show Documentation introduced 2017-03-07 10:55 UTC by Report Bug Copy Issue Report `$action` is of type `*`, but the function expects a `callable`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
58	8		$this->routes[] = $route;
59
60	8		return $route;
61			}
62
63
64
65			/**
66			* Add aroute to the router with specific request method.
67			*
68			* @param array $method as array of strings of request methods
69			* @param string $rule for this route
70			* @param mixed $action null, string or callable to implement a
71			* controller for the route
72			*
73			* @return class as new route
74			*/
75	3	View Code Duplication	public function any($method, $rule, $action = null)
			0 ignored issues – show Duplication introduced 2017-03-13 17:07 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
76			{
77	3		$route = new Route();
78	3		$route->set($rule, $action, $method);
			0 ignored issues – show Documentation introduced 2017-03-13 17:07 UTC by Report Bug Copy Issue Report `$action` is of type `*`, but the function expects a `callable`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
79	3		$this->routes[] = $route;
80
81	3		return $route;
82			}
83
84
85
86			/**
87			* Add a GET route to the router.
88			*
89			* @param string $rule for this route
90			* @param mixed $action null, string or callable to implement a
91			* controller for the route
92			*
93			* @return class as new route
94			*/
95	1		public function get($rule, $action = null)
96			{
97	1		return $this->any(["GET"], $rule, $action);
98			}
99
100
101
102			/**
103			* Add a POST route to the router.
104			*
105			* @param string $rule for this route
106			* @param mixed $action null, string or callable to implement a
107			* controller for the route
108			*
109			* @return class as new route
110			*/
111	1		public function post($rule, $action = null)
112			{
113	1		return $this->any(["POST"], $rule, $action);
114			}
115
116
117
118			/**
119			* Add a PUT route to the router.
120			*
121			* @param string $rule for this route
122			* @param mixed $action null, string or callable to implement a
123			* controller for the route
124			*
125			* @return class as new route
126			*/
127	1		public function put($rule, $action = null)
128			{
129	1		return $this->any(["PUT"], $rule, $action);
130			}
131
132
133
134			/**
135			* Add a DELETE route to the router.
136			*
137			* @param string $rule for this route
138			* @param mixed $action null, string or callable to implement a
139			* controller for the route
140			*
141			* @return class as new route
142			*/
143	1		public function delete($rule, $action = null)
144			{
145	1		return $this->any(["DELETE"], $rule, $action);
146			}
147
148
149
150			/**
151			* Add an internal (not exposed to url-matching) route to the router.
152			*
153			* @param string $rule for this route
154			* @param mixed $action null, string or callable to implement a controller for the route
155			*
156			* @return class as new route
157			*/
158	3		public function addInternal($rule, $action = null)
159			{
160	3		$route = new Route();
161	3		$route->set($rule, $action);
			0 ignored issues – show Documentation introduced 2017-03-07 10:55 UTC by Report Bug Copy Issue Report `$action` is of type `*`, but the function expects a `callable`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
162	3		$this->internalRoutes[$rule] = $route;
163	3		return $route;
164			}
165
166
167
168			/**
169			* Add an internal (not exposed to url-matching) route to the router.
170			*
171			* @param string $rule for this route
172			* @param mixed $action null, string or callable to implement a
			0 ignored issues – show Bug introduced 2017-03-07 10:55 UTC by Report Bug Copy Issue Report There is no parameter named `$action`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
173			* controller for the route
174			*
175			* @return void
176			*/
177	4		public function handleInternal($rule)
178			{
179	4		if (!isset($this->internalRoutes[$rule])) {
180	1		throw new NotFoundException("No internal route to handle: " . $rule);
181			}
182	3		$route = $this->internalRoutes[$rule];
183	3		$this->lastRoute = $rule;
184	3		$route->handle();
185			}
186
187
188
189			/**
190			* Get the route for the last route that was handled.
191			*
192			* @return mixed
193			*/
194			public function getLastRoute()
195			{
196			return $this->lastRoute;
197			}
198
199
200
201			/**
202			* Handle the routes and match them towards the request, dispatch them
203			* when a match is made. Each route handler may throw exceptions that
204			* may redirect to an internal route for error handling.
205			*
206			* @param string $query the query/route to match a handler for.
207			* @param string $method the request method to match.
208			*
209			* @return mixed content returned from route.
210			*/
211	9		public function handle($query, $method = null)
212			{
213			try {
214			// Match predefined routes
215	9		foreach ($this->routes as $route) {
216	8		if ($route->match($query, $method)) {
217	8		$this->lastRoute = $route->getRule();
218	8		return $route->handle();
219			}
220	4		}
221
222			// No route was matched
223	1		$this->handleInternal("404");
224	4		} catch (ForbiddenException $e) {
225	1		$this->handleInternal("403");
226	3		} catch (NotFoundException $e) {
227	2		$this->handleInternal("404");
228	1		} catch (InternalErrorException $e) {
229	1		$this->handleInternal("500");
230			}
231			}
232			}
233

canax / router

Push — master ( 9a0f12...ce5c53 )

RouterInjectable::addDefault() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like