Routing::dispatch() - Code Metrics - Logi-CE/fmup - Measure and Improve Code Quality continuously with Scrutinizer

Routing::dispatch() B
last analyzed 2017-12-05 10:44 UTC

↳ Parent: Routing

Complexity

Conditions	5
Paths	4

Size

Total Lines	21
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	14
CRAP Score	5

Importance

Changes

Metric	Value
cc	5
eloc	15
nc	4
nop	1
dl	0
loc	21
ccs	14
cts	14
cp	1
crap	5
rs	8.7624
c	0
b	0
f	0

<?php
namespace FMUP;

use FMUP\Routing\Route;

/**
 * Class Routing - Routing system where we'll be able to handle multiple route to be handled in a controller
 * @package FMUP
 */
class Routing
{
    const WAY_APPEND = 'WAY_APPEND';
    const WAY_PREPEND = 'WAY_PREPEND';
    /**
     * List of routes to check on routing
     * @var array
     */
    private $routes = array();

    /**
     * @var Request
     */
    private $originalRequest;

    /**
     * Dispatch routes and return the first available route
     * @param Request $request
     * @return Route|null
     */
    public function dispatch(Request $request)
    {
        $this->setOriginalRequest($request);
        $redispatch = false;
        $routeSelected = null;
        $this->defaultRoutes();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
        do {
            foreach ($this->getRoutes() as $route) {
                if ($route->setRequest($request)->canHandle()) {
                    //this will handle the request - not fluent interface because we don't know how developer will write
                    $route->handle();
                    $redispatch = $route->hasToBeReDispatched();
                    if (!$redispatch) {
                        $routeSelected = $route;
                    }
                    break;
                }
            }
        } while ($redispatch);
        return $routeSelected;
    }

    /**
     * Define the original request
     * @param Request $request
     * @return $this
     */
    private function setOriginalRequest(Request $request)
    {
        $this->originalRequest = clone $request;
        return $this;
    }

    /**
     * Retrieve original request (nothing has been modified)
     * @return Request|null
     */
    public function getOriginalRequest()
    {
        return $this->originalRequest;
    }

    /**
     * Retrieve defined routes
     * @return Route[]
     */
    public function getRoutes()
    {
        return $this->routes;
    }


    /**
     * Clear all routes defined
     * @return $this
     */
    public function clearRoutes()
    {
        $this->routes = array();
        return $this;
    }

    /**
     * Add a route in stack
     * @param Route $route
     * @param string $way
     * @return $this
     */
    public function addRoute(Route $route, $way = self::WAY_APPEND)
    {
        if ($way == self::WAY_PREPEND) {
            array_unshift($this->routes, $route);
        } else {
            array_push($this->routes, $route);
        }
        return $this;
    }

    /**
     * Can be used to define routes initialized by default
     * @return $this
     */
    public function defaultRoutes()
    {
        return $this;
    }
}


1		<?php
2		namespace FMUP;
3
4		use FMUP\Routing\Route;
5
6		/**
7		* Class Routing - Routing system where we'll be able to handle multiple route to be handled in a controller
8		* @package FMUP
9		*/
10		class Routing
11		{
12		const WAY_APPEND = 'WAY_APPEND';
13		const WAY_PREPEND = 'WAY_PREPEND';
14		/**
15		* List of routes to check on routing
16		* @var array
17		*/
18		private $routes = array();
19
20		/**
21		* @var Request
22		*/
23		private $originalRequest;
24
25		/**
26		* Dispatch routes and return the first available route
27		* @param Request $request
28		* @return Route\|null
29		*/
30	9	public function dispatch(Request $request)
31		{
32	9	$this->setOriginalRequest($request);
33	9	$redispatch = false;
34	9	$routeSelected = null;
35	9	$this->defaultRoutes();
		0 ignored issues – show Unused Code introduced 2017-04-18 14:53 UTC by Report Bug Copy Issue Report The call to the method `FMUP\Routing::defaultRoutes()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
36		do {
37	9	foreach ($this->getRoutes() as $route) {
38	2	if ($route->setRequest($request)->canHandle()) {
39		//this will handle the request - not fluent interface because we don't know how developer will write
40	2	$route->handle();
41	2	$redispatch = $route->hasToBeReDispatched();
42	2	if (!$redispatch) {
43	2	$routeSelected = $route;
44		}
45	2	break;
46		}
47		}
48	9	} while ($redispatch);
49	9	return $routeSelected;
50		}
51
52		/**
53		* Define the original request
54		* @param Request $request
55		* @return $this
56		*/
57	9	private function setOriginalRequest(Request $request)
58		{
59	9	$this->originalRequest = clone $request;
60	9	return $this;
61		}
62
63		/**
64		* Retrieve original request (nothing has been modified)
65		* @return Request\|null
66		*/
67	1	public function getOriginalRequest()
68		{
69	1	return $this->originalRequest;
70		}
71
72		/**
73		* Retrieve defined routes
74		* @return Route[]
75		*/
76	11	public function getRoutes()
77		{
78	11	return $this->routes;
79		}
80
81
82		/**
83		* Clear all routes defined
84		* @return $this
85		*/
86	1	public function clearRoutes()
87		{
88	1	$this->routes = array();
89	1	return $this;
90		}
91
92		/**
93		* Add a route in stack
94		* @param Route $route
95		* @param string $way
96		* @return $this
97		*/
98	4	public function addRoute(Route $route, $way = self::WAY_APPEND)
99		{
100	4	if ($way == self::WAY_PREPEND) {
101	4	array_unshift($this->routes, $route);
102		} else {
103	4	array_push($this->routes, $route);
104		}
105	4	return $this;
106		}
107
108		/**
109		* Can be used to define routes initialized by default
110		* @return $this
111		*/
112	8	public function defaultRoutes()
113		{
114	8	return $this;
115		}
116		}
117

Logi-CE / fmup

Routing::dispatch() B last analyzed 2017-12-05 10:44 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Routing::dispatch() B
last analyzed 2017-12-05 10:44 UTC