RSlim::runRoute() - Code Metrics - Inspection of "useTwig separated from runRoute" - reformo/rslim - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( cffccc...644e08 )

by Mehmet

created 2016-05-09 11:12 UTC

RSlim::runRoute() C

↳ Parent: RSlim

Complexity

Conditions	11
Paths	27

Size

Total Lines	58
Code Lines	41

Duplication

Lines	6
Ratio	10.34 %

Importance

Changes	3
Bugs	1	Features	0

Metric	Value
cc	11
eloc	41
c	3
b	1
f	0
nc	27
nop	6
dl	6
loc	58
rs	6.4179

How to fix Long Method Complexity

<?php

namespace RSlim;

use \Psr\Http\Message\RequestInterface as Request;
use \Psr\Http\Message\ResponseInterface as Response;

class RSlim
{

    public $config = [
        'base_dir' => null,
        'app_dir' => 'apps/_skel',
        'base_url' => null,
        'app_name' => 'www',
        'bypass_error_handlers' => true
    ];
    public $container = null;
    public $app = null;
    private $twig = null;

    public function __construct($config)
    {
        $this->config = array_merge($this->config, $config);
        ini_set("default_charset", "utf-8");
        ini_set('date.timezone', $config['app']['timezone']);
        $configuration = [
            'settings' => [
                'displayErrorDetails' => $config['app']['debug'],
            ],
        ];
        $this->container = new \Slim\Container($configuration);
        $this->app = new \Slim\App($this->container);
    }

    public function runRoute($request, $response, $route, $action = 'main', $return_type = 'html', $args = [])
    {
        $controller = $this->config['base_dir'] . '/' . $this->config['app_dir'] . '/controllers/' . $route . '/' . $action . '.php';
        $template   = '/' . $this->config['app_dir'] . '/templates/' . $route . '/' . $action . '.html';

        if (file_exists($controller)) {
            require_once($controller);
            
            if ($return_type == 'html') {
                $this->useTwig($request);
            }

            $function_name = $route.'_'.$action;
            if (!function_exists($function_name)) {
                return $this->notFound($request, $response, $return_type, 'Controller ' . $route . '/' . $action . " has not " . $function_name . " function");
            }
            if ($return_type == 'json') {
                $status = 500;
                $function_output = call_user_func($function_name, $request, $args);
                if (!is_array($function_output)) {
                    $function_output = ["status" => 500, "error" => "Internal Server Error"];
                } else {
                    if (!isset($function_output['status'])) {
                        $function_output['status'] = 200;
                    }
                    $status = (int) $function_output['status'];
                }
                $response->getBody()->write(json_encode($function_output));
                $newResponse = $response->withHeader('Content-Type', 'application/json;charset=utf-8')->withHeader('X-Powered-By', "reformo/rslim")->withStatus($status);
            } else {
                if (!file_exists($this->config['base_dir'] . $template)) {

                    throw new \Exception("<strong>Template file not found!</strong> " . $route . '/' . $action . " needs a template file at:" . $template);
                }
                $function_output = call_user_func($function_name, $request, $args);
                if (!isset($function_output['data'])) {
                    $function_output['data'] = [];
                }

                $function_output['app_content'] = $this->twig->render($template, $function_output['data']);
                $main_template_name = 'default';
                if (isset($function_output['app_main_template'])) {
                    $main_template_name = $function_output['app_main_template'];
                }
                $main_template = '/' . $this->config['app_dir'] . '/templates/_' . $main_template_name . '.html';

                if (!file_exists($this->config['base_dir'] . $main_template)) {

                    throw new \Exception("<strong>Main emplate file not found!</strong> ".$route . '/' . $action .
                                            " needs a main template file at:" . $main_template);
                }
                $app_content = $this->twig->render($main_template, $function_output);
                $newResponse = $response->withHeader('X-Powered-By', "reformo/rslim");
                $newResponse->write($app_content);
            }
            return $newResponse;
        } else {
            return $this->notFound($request, $response, $return_type, 'Controller ' . $route . '/' . $action . " not found");
        }
    }
    
    private function useTwig($request)
    {
        $loader     = new \Twig_Loader_Filesystem($this->config['base_dir']);
        $this->twig = new \Twig_Environment($loader, [
            'cache'         => '/tmp',
            'debug'         => $this->config['app']['debug'],
            'auto_reload'   => 1
        ]);
        $filter = new \Twig_SimpleFunction(
            'rwidget_*_*',
            function($widget_name, $widget_action, $args = []) {
        
                $widget_file = $this->config['base_dir'] . '/' . $this->config['app_dir'] . '/widgets/' . $widget_name . '/' . $widget_action . ".php";
                $widget_template = '/' . $this->config['app_dir'] . '/templates/_widgets/' . $widget_name . '/' . $widget_action . '.html';
                if (!file_exists($widget_file)) {
                    throw new \Exception("<strong>Widget file not found!</strong> " . $widget_name . '/' . $widget_action . "!");
                }
                require_once $widget_file;
                $widget_content_function = "rwidget_" . $widget_name . "_" . $widget_action;
                if (function_exists($widget_content_function)) {
                    $widget_content = call_user_func($widget_content_function, $args);
                    if (!file_exists($this->config['base_dir'] . $widget_template)) {
                        if (is_string($widget_content)) {
                            return $widget_content;
                        } else {
                            throw new \Exception("<strong>Widget should return string:</strong> " . $widget_name . '/' . $widget_action . "!");
                        }
                    } else {
                        return $this->twig->render($widget_template, $widget_content);
                    }
                } else {
                    throw new \Exception("<strong>Widget function not found!</strong> " . $widget_name . '/' . $widget_action . "!");
                }
            },
            array('is_safe' => array('html'))
            );
        $this->twig->addFunction($filter);
        $this->twig->addGlobal('runtime_config', $this->config);
        $this->twig->addGlobal('url_params', $request->getParams());
    }

    public function notFound($request, $response, $return_type = 'html', $message = "")

    {

        $not_found_template = '/' . $this->config['app_dir'] . '/templates/_404.html';
        if ($return_type == 'json') {
            $response->getBody()->write(json_encode(['status'=>404, 'message'=>$message]));
            return $response->withHeader('Content-Type', 'application/json;charset=utf-8')
                ->withHeader('X-Powered-By', "reformo/rslim")->withStatus(404);
        } else {
            return $response->withStatus(404)
                ->withHeader('Content-Type', 'text/html')->withHeader('X-Powered-By', "reformo/rslim")
                ->write($this->twig->render($not_found_template, ['message'=>$message]));
        }
    }

    public function register($request_method, $pattern, $controller, $return_type = 'html')
    {
        $this->app->map([strtoupper($request_method)], $pattern, function(Request $req, Response $res, $args) {
            list($route, $action) = explode("/", $args['controller']);
            return $args['RSlim']->runRoute($req, $res, $route, $action, $args['return_type'], $args);
        })->setArguments(['controller'=>$controller, 'return_type'=>$return_type, 'RSlim'=>$this]);
    }

    public function run()
    {
        $this->container['notFoundHandler'] = function($c) {
            return function(Request $req, Response $res) use ($c) {

                return $c['response']
                    ->withStatus(404)
                    ->withHeader('Content-Type', 'text/html')->withHeader('X-Powered-By', "reformo/rslim")
                    ->write('<h1>404 - Requested URL not found</h1>');
            };
        };
        if ($this->config['bypass_error_handlers'] === true) {
            $this->container['errorHandler'] = function($container) {

                return function($request, $response, $exception) use ($container) {
                    $response->getBody()->rewind();
                    return $response->withStatus(500)
                        ->withHeader('Content-Type', 'text/html')
                        ->write($exception->getMessage());
                };
            };
            $this->container['phpErrorHandler'] = function($container) {

                return function($request, $response, $error) use ($container) {
                    $response->getBody()->rewind();
                    return $response->withStatus(500)
                        ->withHeader('Content-Type', 'text/html')
                        ->write($error->getMessage());
                };
            };
        }
        $this->app->run();
    }
}


1		<?php
2
3		namespace RSlim;
4
5		use \Psr\Http\Message\RequestInterface as Request;
6		use \Psr\Http\Message\ResponseInterface as Response;
7
8		class RSlim
9		{
10
11		public $config = [
12		'base_dir' => null,
13		'app_dir' => 'apps/_skel',
14		'base_url' => null,
15		'app_name' => 'www',
16		'bypass_error_handlers' => true
17		];
18		public $container = null;
19		public $app = null;
20		private $twig = null;
21
22		public function __construct($config)
23		{
24		$this->config = array_merge($this->config, $config);
25		ini_set("default_charset", "utf-8");
26		ini_set('date.timezone', $config['app']['timezone']);
27		$configuration = [
28		'settings' => [
29		'displayErrorDetails' => $config['app']['debug'],
30		],
31		];
32		$this->container = new \Slim\Container($configuration);
33		$this->app = new \Slim\App($this->container);
34		}
35
36		public function runRoute($request, $response, $route, $action = 'main', $return_type = 'html', $args = [])
37		{
38		$controller = $this->config['base_dir'] . '/' . $this->config['app_dir'] . '/controllers/' . $route . '/' . $action . '.php';
39		$template = '/' . $this->config['app_dir'] . '/templates/' . $route . '/' . $action . '.html';
40
41		if (file_exists($controller)) {
42		require_once($controller);
43
44		if ($return_type == 'html') {
45		$this->useTwig($request);
46		}
47
48		$function_name = $route.'_'.$action;
49		if (!function_exists($function_name)) {
50		return $this->notFound($request, $response, $return_type, 'Controller ' . $route . '/' . $action . " has not " . $function_name . " function");
51		}
52		if ($return_type == 'json') {
53		$status = 500;
54		$function_output = call_user_func($function_name, $request, $args);
55		if (!is_array($function_output)) {
56		$function_output = ["status" => 500, "error" => "Internal Server Error"];
57		} else {
58		if (!isset($function_output['status'])) {
59		$function_output['status'] = 200;
60		}
61		$status = (int) $function_output['status'];
62		}
63		$response->getBody()->write(json_encode($function_output));
64		$newResponse = $response->withHeader('Content-Type', 'application/json;charset=utf-8')->withHeader('X-Powered-By', "reformo/rslim")->withStatus($status);
65		} else {
66	View Code Duplication	if (!file_exists($this->config['base_dir'] . $template)) {
		0 ignored issues – show Duplication introduced 2016-05-03 06:45 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
67		throw new \Exception("<strong>Template file not found!</strong> " . $route . '/' . $action . " needs a template file at:" . $template);
68		}
69		$function_output = call_user_func($function_name, $request, $args);
70		if (!isset($function_output['data'])) {
71		$function_output['data'] = [];
72		}
73
74		$function_output['app_content'] = $this->twig->render($template, $function_output['data']);
75		$main_template_name = 'default';
76		if (isset($function_output['app_main_template'])) {
77		$main_template_name = $function_output['app_main_template'];
78		}
79		$main_template = '/' . $this->config['app_dir'] . '/templates/_' . $main_template_name . '.html';
80
81	View Code Duplication	if (!file_exists($this->config['base_dir'] . $main_template)) {
		0 ignored issues – show Duplication introduced 2016-05-03 06:45 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
82		throw new \Exception("<strong>Main emplate file not found!</strong> ".$route . '/' . $action .
83		" needs a main template file at:" . $main_template);
84		}
85		$app_content = $this->twig->render($main_template, $function_output);
86		$newResponse = $response->withHeader('X-Powered-By', "reformo/rslim");
87		$newResponse->write($app_content);
88		}
89		return $newResponse;
90		} else {
91		return $this->notFound($request, $response, $return_type, 'Controller ' . $route . '/' . $action . " not found");
92		}
93		}
94
95		private function useTwig($request)
96		{
97		$loader = new \Twig_Loader_Filesystem($this->config['base_dir']);
98		$this->twig = new \Twig_Environment($loader, [
99		'cache' => '/tmp',
100		'debug' => $this->config['app']['debug'],
101		'auto_reload' => 1
102		]);
103		$filter = new \Twig_SimpleFunction(
104		'rwidget__',
105		function($widget_name, $widget_action, $args = []) {
106
107		$widget_file = $this->config['base_dir'] . '/' . $this->config['app_dir'] . '/widgets/' . $widget_name . '/' . $widget_action . ".php";
108		$widget_template = '/' . $this->config['app_dir'] . '/templates/_widgets/' . $widget_name . '/' . $widget_action . '.html';
109		if (!file_exists($widget_file)) {
110		throw new \Exception("<strong>Widget file not found!</strong> " . $widget_name . '/' . $widget_action . "!");
111		}
112		require_once $widget_file;
113		$widget_content_function = "rwidget_" . $widget_name . "_" . $widget_action;
114		if (function_exists($widget_content_function)) {
115		$widget_content = call_user_func($widget_content_function, $args);
116		if (!file_exists($this->config['base_dir'] . $widget_template)) {
117		if (is_string($widget_content)) {
118		return $widget_content;
119		} else {
120		throw new \Exception("<strong>Widget should return string:</strong> " . $widget_name . '/' . $widget_action . "!");
121		}
122		} else {
123		return $this->twig->render($widget_template, $widget_content);
124		}
125		} else {
126		throw new \Exception("<strong>Widget function not found!</strong> " . $widget_name . '/' . $widget_action . "!");
127		}
128		},
129		array('is_safe' => array('html'))
130		);
131		$this->twig->addFunction($filter);
132		$this->twig->addGlobal('runtime_config', $this->config);
133		$this->twig->addGlobal('url_params', $request->getParams());
134		}
135
136		public function notFound($request, $response, $return_type = 'html', $message = "")
		0 ignored issues – show Unused Code introduced 2016-05-03 06:45 UTC by Report Bug Copy Issue Report The parameter `$request` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
137		{
138
139		$not_found_template = '/' . $this->config['app_dir'] . '/templates/_404.html';
140		if ($return_type == 'json') {
141		$response->getBody()->write(json_encode(['status'=>404, 'message'=>$message]));
142		return $response->withHeader('Content-Type', 'application/json;charset=utf-8')
143		->withHeader('X-Powered-By', "reformo/rslim")->withStatus(404);
144		} else {
145		return $response->withStatus(404)
146		->withHeader('Content-Type', 'text/html')->withHeader('X-Powered-By', "reformo/rslim")
147		->write($this->twig->render($not_found_template, ['message'=>$message]));
148		}
149		}
150
151		public function register($request_method, $pattern, $controller, $return_type = 'html')
152		{
153		$this->app->map([strtoupper($request_method)], $pattern, function(Request $req, Response $res, $args) {
154		list($route, $action) = explode("/", $args['controller']);
155		return $args['RSlim']->runRoute($req, $res, $route, $action, $args['return_type'], $args);
156		})->setArguments(['controller'=>$controller, 'return_type'=>$return_type, 'RSlim'=>$this]);
157		}
158
159		public function run()
160		{
161		$this->container['notFoundHandler'] = function($c) {
162		return function(Request $req, Response $res) use ($c) {
		0 ignored issues – show Unused Code introduced 2016-05-03 06:45 UTC by Report Bug Copy Issue Report The parameter `$req` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2016-05-03 06:45 UTC by Report Bug Copy Issue Report The parameter `$res` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
163		return $c['response']
164		->withStatus(404)
165		->withHeader('Content-Type', 'text/html')->withHeader('X-Powered-By', "reformo/rslim")
166		->write('<h1>404 - Requested URL not found</h1>');
167		};
168		};
169		if ($this->config['bypass_error_handlers'] === true) {
170	View Code Duplication	$this->container['errorHandler'] = function($container) {
		0 ignored issues – show Duplication introduced 2016-05-03 06:45 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
171		return function($request, $response, $exception) use ($container) {
172		$response->getBody()->rewind();
173		return $response->withStatus(500)
174		->withHeader('Content-Type', 'text/html')
175		->write($exception->getMessage());
176		};
177		};
178	View Code Duplication	$this->container['phpErrorHandler'] = function($container) {
		0 ignored issues – show Duplication introduced 2016-05-03 06:45 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
179		return function($request, $response, $error) use ($container) {
180		$response->getBody()->rewind();
181		return $response->withStatus(500)
182		->withHeader('Content-Type', 'text/html')
183		->write($error->getMessage());
184		};
185		};
186		}
187		$this->app->run();
188		}
189		}
190

reformo / rslim

Push — master ( cffccc...644e08 )

RSlim::runRoute() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like