RouterInjectable::addInternal() - Code Metrics - Inspection of "Enhancing unittest" - canax/router - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( cebcdc...df6a12 )

by Mikael

created 2017-03-07 10:53 UTC

RouterInjectable::addInternal() A

↳ Parent: RouterInjectable

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	7
ccs	5
cts	5
cp	1
rs	9.4285
cc	1
eloc	5
nc	1
nop	2
crap	1

<?php

namespace Anax\Route;

/**
 * A container for routes.
 *
 */
class RouterInjectable
{
    /**
     * Properties
     *
     */
    private $routes         = [];    // All the routes
    private $internalRoutes = [];    // All internal routes
    private $defaultRoute   = null;  // A default route to catch all



    /**
     * 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;

        // Set as default route
        if ($rule == "*") {
            $this->defaultRoute = $route;
        }

        return $route;
    }



    /**
     * Add a default route to the router, to use when all other routes fail.
     *
     * @param mixed  $action null, string or callable to implement a controller for the route
     *
     * @return class as new route
     */
    public function addDefault($action)

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

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->routes[] = $route;
        $this->defaultRoute = $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 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];
        $route->handle();
    }



    /**
     * 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.
     *
     * @return mixed content returned from route.
     */
    public function handle($query)
    {
        try {
            // Match predefined routes
            foreach ($this->routes as $route) {
                if ($route->match($query)) {
                    return $route->handle();
                }
            }

            // Use the "catch-all" route
            if ($this->defaultRoute) {
                return $this->defaultRoute->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 $defaultRoute = null; // A default route to catch all
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 controller for the route
50			*
51			* @return class as new route
52			*/
53	5	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...
54			{
55	5		$route = new Route();
56	5		$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...
57	5		$this->routes[] = $route;
58
59			// Set as default route
60	5		if ($rule == "*") {
61	1		$this->defaultRoute = $route;
62	1		}
63
64	5		return $route;
65			}
66
67
68
69			/**
70			* Add a default route to the router, to use when all other routes fail.
71			*
72			* @param mixed $action null, string or callable to implement a controller for the route
73			*
74			* @return class as new route
75			*/
76	1	View Code Duplication	public function addDefault($action)
			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...
77			{
78	1		$route = new Route();
79	1		$route->set("*", $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...
80	1		$this->routes[] = $route;
81	1		$this->defaultRoute = $route;
82
83	1		return $route;
84			}
85
86
87
88			/**
89			* Add an internal (not exposed to url-matching) route to the router.
90			*
91			* @param string $rule for this route
92			* @param mixed $action null, string or callable to implement a controller for the route
93			*
94			* @return class as new route
95			*/
96	3		public function addInternal($rule, $action = null)
97			{
98	3		$route = new Route();
99	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...
100	3		$this->internalRoutes[$rule] = $route;
101	3		return $route;
102			}
103
104
105
106			/**
107			* Add an internal (not exposed to url-matching) route to the router.
108			*
109			* @param string $rule for this route
110			* @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...
111			* controller for the route
112			*
113			* @return void
114			*/
115	4		public function handleInternal($rule)
116			{
117	4		if (!isset($this->internalRoutes[$rule])) {
118	1		throw new NotFoundException("No internal route to handle: " . $rule);
119			}
120	3		$route = $this->internalRoutes[$rule];
121	3		$route->handle();
122			}
123
124
125
126			/**
127			* Handle the routes and match them towards the request, dispatch them
128			* when a match is made. Each route handler may throw exceptions that
129			* may redirect to an internal route for error handling.
130			*
131			* @param string $query the query/route to match a handler for.
132			*
133			* @return mixed content returned from route.
134			*/
135	6		public function handle($query)
136			{
137			try {
138			// Match predefined routes
139	6		foreach ($this->routes as $route) {
140	5		if ($route->match($query)) {
141	5		return $route->handle();
142			}
143	2		}
144
145			// Use the "catch-all" route
146	1		if ($this->defaultRoute) {
147			return $this->defaultRoute->handle();
148			}
149
150			// No route was matched
151	1		$this->handleInternal("404");
152	4		} catch (ForbiddenException $e) {
153	1		$this->handleInternal("403");
154	3		} catch (NotFoundException $e) {
155	2		$this->handleInternal("404");
156	1		} catch (InternalErrorException $e) {
157	1		$this->handleInternal("500");
158			}
159			}
160			}
161

canax / router

Push — master ( cebcdc...df6a12 )

RouterInjectable::addInternal() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like