Dispatcher::__construct() - Code Metrics - Inspection of "get more tests passing" - delboy1978uk/bone - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — dev-master ( 82c8e5...74b82e )

by Derek Stephen

created 2017-02-04 12:00 UTC

Dispatcher::__construct() A

↳ Parent: Dispatcher

Complexity

Conditions	1
Paths	1

Size

Total Lines	18
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace Bone\Mvc;

use Bone\Filter;
use Exception;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use ReflectionClass;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\ResponseInterface;
use Zend\Diactoros\Response\SapiEmitter;

/**
 * Class Dispatcher
 * @package Bone\Mvc
 */
class Dispatcher
{
    // Garrrr! An arrrray!
    private $config = array();

    /** @var ServerRequestInterface $request */
    private $request;

    /** @var Controller */
    private $controller;

    /** @var ResponseInterface $response */
    private $response;


    public function __construct(ServerRequestInterface $request, ResponseInterface $response)
    {
        $this->request = $request;
        $this->response = $response;

        $router = new Router($request);
        $router->parseRoute();

        // what controller be we talkin' about?
        $filtered = Filter::filterString($router->getController(), 'DashToCamelCase');
        $this->config['controller_name'] = '\App\Controller\\' . ucwords($filtered) . 'Controller';

        // whit be yer action ?
        $filtered = Filter::filterString($router->getAction(), 'DashToCamelCase');
        $this->config['action_name'] = $filtered . 'Action';
        $this->config['controller'] = $router->getController();
        $this->config['action'] = $router->getAction();
    }


    /**
     *  Gaaarrr! Check the Navigator be readin' the map!
     */
    public function checkNavigator()
    {
        // can we find th' darned controller?
        if (!$this->checkControllerExists()) {
            $this->setNotFound();
            return;
        }

        // gaaarr! there be the controller!
        $this->controller = new $this->config['controller_name']($this->request);

        // where's the bloody action?
        if (!$this->checkActionExists()) {
            $this->setNotFound();
        }
    }


    /**
     * @return bool
     */
    private function checkControllerExists()
    {
        return class_exists($this->config['controller_name']);
    }


    /**
     * @return bool
     */
    private function checkActionExists()
    {
        return method_exists($this->controller, $this->config['action_name']);
    }


    /**
     * @return string
     * @throws \Exception
     */
    private function getResponseBody()
    {
        /** @var \stdClass $view_vars */
        $view_vars = $this->controller->view;

        $response_body = $this->controller->getBody();

        if ($this->controller->hasViewEnabled()) {
            $view = $this->config['controller'] . '/' . $this->config['action'];
            try {
                $response_body = $this->controller->getViewEngine()->render($view, (array) $view_vars);
            } catch (Exception $e) {
                throw $e;
            }
        }

        if ($this->controller->hasLayoutEnabled()) {
            $response_body = $this->templateCheck($this->controller, $response_body);
        }
        return $response_body;
    }


    /**
     *
     */
    public function fireCannons()
    {
        try {
            // Where be the navigator? Be we on course?
            $this->checkNavigator();

            // boom! direct hit Cap'n! Be gettin' the booty!
            $this->plunderEnemyShip();

            // show th' cap'n th' booty
            $booty = $this->getResponseBody();
        } catch (Exception $e) {
            $booty = $this->sinkingShip($e);
        }

        $this->response->getBody()->write($booty);

        // report back to th' cap'n
        $this->setHeaders();

        $emitter = new SapiEmitter();
        ob_start();
        $emitter->emit($this->response);
        $content = ob_get_contents();
        ob_end_clean();
        return  $content;
    }

    private function setHeaders()
    {
        foreach ($this->controller->getHeaders() as $key => $value) {
            $this->response = $this->response->withHeader($key, $value);
        }
    }


    private function plunderEnemyShip()
    {
        // run th' controller action
        $action = $this->config['action_name'];
        $this->controller->init();
        $vars = $this->controller->$action();
        if (is_array($vars)) {
            $viewVars = (array) $this->controller->view;
            $view = (object) array_merge($vars, $viewVars);
            $this->controller->view =$view;
        }
        $this->controller->postDispatch();
    }


    public function sinkingShip($e)
    {
        $this->controller = class_exists('\App\Controller\ErrorController') ? new \App\Controller\ErrorController($this->request) : new Controller($this->request);
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        $this->controller->setParam('error', $e);
        $reflection = new ReflectionClass(get_class($this->controller));
        $method = $reflection->getMethod('errorAction');
        $method->setAccessible(true);
        $method->invokeArgs($this->controller, []);
        $this->controller->error = $e;
        $this->config['controller'] = 'error';
        $this->config['action'] = 'error';
        return $this->getResponseBody();
    }


    /**
     * @param Controller $controller
     * @param string $content
     * @return string
     */
    private function templateCheck($controller, $content)
    {
        $response_body = '';
        //check we be usin' th' templates in th' config
        $templates = Registry::ahoy()->get('templates');
        $template = $this->getTemplateName($templates);
        if ($template) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $response_body = $controller->getViewEngine()->render('layouts/' . $template, array('content' => $content));
        }
        return $response_body;
    }

    /**
     * @param mixed $templates
     * @return string|null
     */
    private function getTemplateName($templates)
    {
        if (is_null($templates)) {
            return null;
        } elseif (is_array($templates)) {
            return $templates[0];
        }
        return $templates;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Sets controller to error and action to not found
     * @return void
     */
    private function setNotFound()
    {
        $this->config['controller_name'] = class_exists('\App\Controller\ErrorController') ? '\App\Controller\ErrorController' : '\Bone\Mvc\Controller';
        $this->config['action_name'] = 'notFoundAction';
        $this->config['controller'] = 'error';
        $this->config['action'] = 'not-found';
        $this->controller = new $this->config['controller_name']($this->request);
    }
}


1		<?php
2
3		namespace Bone\Mvc;
4
5		use Bone\Filter;
6		use Exception;
		0 ignored issues – show Bug introduced 2016-04-11 07:17 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `Bone\Mvc\Exception`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
7		use ReflectionClass;
8		use Psr\Http\Message\ServerRequestInterface;
9		use Psr\Http\Message\ResponseInterface;
10		use Zend\Diactoros\Response\SapiEmitter;
11
12		/**
13		* Class Dispatcher
14		* @package Bone\Mvc
15		*/
16		class Dispatcher
17		{
18		// Garrrr! An arrrray!
19		private $config = array();
20
21		/** @var ServerRequestInterface $request */
22		private $request;
23
24		/** @var Controller */
25		private $controller;
26
27		/** @var ResponseInterface $response */
28		private $response;
29
30
31	9	public function __construct(ServerRequestInterface $request, ResponseInterface $response)
32	9	{
33	9	$this->request = $request;
34	9	$this->response = $response;
35
36	9	$router = new Router($request);
37	9	$router->parseRoute();
38
39		// what controller be we talkin' about?
40	9	$filtered = Filter::filterString($router->getController(), 'DashToCamelCase');
41	9	$this->config['controller_name'] = '\App\Controller\\' . ucwords($filtered) . 'Controller';
42
43		// whit be yer action ?
44	9	$filtered = Filter::filterString($router->getAction(), 'DashToCamelCase');
45	9	$this->config['action_name'] = $filtered . 'Action';
46	9	$this->config['controller'] = $router->getController();
47	9	$this->config['action'] = $router->getAction();
48	9	}
49
50
51		/**
52		* Gaaarrr! Check the Navigator be readin' the map!
53		*/
54	1	public function checkNavigator()
55	1	{
56		// can we find th' darned controller?
57		if (!$this->checkControllerExists()) {
58		$this->setNotFound();
59		return;
60		}
61
62		// gaaarr! there be the controller!
63		$this->controller = new $this->config['controller_name']($this->request);
64
65		// where's the bloody action?
66		if (!$this->checkActionExists()) {
67		$this->setNotFound();
68		}
69		}
70
71
72		/**
73		* @return bool
74		*/
75	1	private function checkControllerExists()
76	1	{
77	1	return class_exists($this->config['controller_name']);
78		}
79
80
81		/**
82		* @return bool
83		*/
84	1	private function checkActionExists()
85	1	{
86	1	return method_exists($this->controller, $this->config['action_name']);
87		}
88
89
90		/**
91		* @return string
92		* @throws \Exception
93		*/
94	3	private function getResponseBody()
95	3	{
96		/** @var \stdClass $view_vars */
97	3	$view_vars = $this->controller->view;
98
99	3	$response_body = $this->controller->getBody();
100
101	3	if ($this->controller->hasViewEnabled()) {
102	2	$view = $this->config['controller'] . '/' . $this->config['action'];
103		try {
104	2	$response_body = $this->controller->getViewEngine()->render($view, (array) $view_vars);
105	1	} catch (Exception $e) {
106	1	throw $e;
107		}
108		}
109
110	3	if ($this->controller->hasLayoutEnabled()) {
111	2	$response_body = $this->templateCheck($this->controller, $response_body);
112		}
113	3	return $response_body;
114		}
115
116
117		/**
118		*
119		*/
120	2	public function fireCannons()
121	2	{
122		try {
123		// Where be the navigator? Be we on course?
124	1	$this->checkNavigator();
125
126		// boom! direct hit Cap'n! Be gettin' the booty!
127	1	$this->plunderEnemyShip();
128
129		// show th' cap'n th' booty
130	1	$booty = $this->getResponseBody();
131	1	} catch (Exception $e) {
132	1	$booty = $this->sinkingShip($e);
133		}
134
135	1	$this->response->getBody()->write($booty);
136
137		// report back to th' cap'n
138	1	$this->setHeaders();
139
140	1	$emitter = new SapiEmitter();
141	1	ob_start();
142	1	$emitter->emit($this->response);
143	1	$content = ob_get_contents();
144	1	ob_end_clean();
145	1	return $content;
146		}
147
148	1	private function setHeaders()
149	1	{
150	1	foreach ($this->controller->getHeaders() as $key => $value) {
151	1	$this->response = $this->response->withHeader($key, $value);
152		}
153	1	}
154
155
156	2	private function plunderEnemyShip()
157	2	{
158		// run th' controller action
159	2	$action = $this->config['action_name'];
160	2	$this->controller->init();
161	2	$vars = $this->controller->$action();
162	2	if (is_array($vars)) {
163	1	$viewVars = (array) $this->controller->view;
164	1	$view = (object) array_merge($vars, $viewVars);
165	1	$this->controller->view =$view;
166		}
167	2	$this->controller->postDispatch();
168	2	}
169
170
171	2	public function sinkingShip($e)
172	2	{
173	1	$this->controller = class_exists('\App\Controller\ErrorController') ? new \App\Controller\ErrorController($this->request) : new Controller($this->request);
		0 ignored issues – show Documentation Bug introduced 2016-04-11 07:17 UTC by Report Bug Copy Issue Report It seems like `class_exists('\\App\\Con...troller($this->request)` can also be of type `object<App\Controller\ErrorController>`. However, the property `$controller` is declared as type `object<Bone\Mvc\Controller>`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
174	1	$this->controller->setParam('error', $e);
175	1	$reflection = new ReflectionClass(get_class($this->controller));
176	1	$method = $reflection->getMethod('errorAction');
177	1	$method->setAccessible(true);
178	1	$method->invokeArgs($this->controller, []);
179	1	$this->controller->error = $e;
180	1	$this->config['controller'] = 'error';
181	1	$this->config['action'] = 'error';
182	1	return $this->getResponseBody();
183		}
184
185
186		/**
187		* @param Controller $controller
188		* @param string $content
189		* @return string
190		*/
191	3	private function templateCheck($controller, $content)
192	3	{
193	3	$response_body = '';
194		//check we be usin' th' templates in th' config
195	3	$templates = Registry::ahoy()->get('templates');
196	3	$template = $this->getTemplateName($templates);
197	3	if ($template) {
		0 ignored issues – show Bug Best Practice introduced 2017-02-04 12:04 UTC by Report Bug Copy Issue Report The expression `$template` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
198	3	$response_body = $controller->getViewEngine()->render('layouts/' . $template, array('content' => $content));
199		}
200	3	return $response_body;
201		}
202
203		/**
204		* @param mixed $templates
205		* @return string\|null
206		*/
207	3	private function getTemplateName($templates)
208	3	{
209	3	if (is_null($templates)) {
210		return null;
211	3	} elseif (is_array($templates)) {
212		return $templates[0];
213		}
214	3	return $templates;
		0 ignored issues – show Bug Best Practice introduced 2017-02-04 12:04 UTC by Report Bug Copy Issue Report The return type of `return $templates;` (`object\|integer\|double\|string\|boolean`) is incompatible with the return type documented by `Bone\Mvc\Dispatcher::getTemplateName` of type `string\|null`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
215		}
216
217		/**
218		* Sets controller to error and action to not found
219		* @return void
220		*/
221	1	private function setNotFound()
222	1	{
223	1	$this->config['controller_name'] = class_exists('\App\Controller\ErrorController') ? '\App\Controller\ErrorController' : '\Bone\Mvc\Controller';
224	1	$this->config['action_name'] = 'notFoundAction';
225	1	$this->config['controller'] = 'error';
226	1	$this->config['action'] = 'not-found';
227	1	$this->controller = new $this->config['controller_name']($this->request);
228	1	}
229		}
230

delboy1978uk / bone

Push — dev-master ( 82c8e5...74b82e )

Dispatcher::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like