Lenevor::gatherRouteMiddleware() - Code Metrics - Inspection of "Merge branch 'master' into 0.7.0" - lenevor/syscodes - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — 0.7.0 ( e442b6...679d5f )

by Alexander
created 2021-03-05 08:21 UTC
Lenevor::gatherRouteMiddleware() A

↳ Parent: Lenevor
Complexity

Conditions	2
Paths	2
Size

Total Lines	7
Code Lines	3
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	2
eloc	3
c	1
b	0
f	0
nc	2
nop	1
dl	0
loc	7
rs	10
<?php

/**
 * Lenevor Framework
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file license.md.
 * It is also available through the world-wide-web at this URL:
 * https://lenevor.com/license
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to [email protected] so we can send you a copy immediately.
 *
 * @package     Lenevor
 * @subpackage  Base
 * @link        https://lenevor.com
 * @copyright   Copyright (c) 2019 - 2021 Alexander Campo <[email protected]>
 * @license     https://opensource.org/licenses/BSD-3-Clause New BSD license or see https://lenevor.com/license or see /license.md
 */

namespace Syscodes\Core\Http;

use Closure;
use Throwable; 
use Syscodes\Routing\Route;
use Syscodes\Routing\Router;
use Syscodes\Routing\Pipeline;
use Syscodes\Support\Facades\Facade;
use Syscodes\Contracts\Core\Application;
use Syscodes\Contracts\Debug\ExceptionHandler;
use Syscodes\Contracts\Http\Lenevor as LenevorContract;

/**
 * The Lenevor class is the heart of the system framework.
 * 
 * @author Alexander Campo <[email protected]>
 */
class Lenevor implements LenevorContract
{
	/**
	 * The application implementation.
	 * 
	 * @var \Syscodes\Contracts\Core\Application $app
	 */
	protected $app;
	
	/**
	 * The bootstrap classes for the application.
	 * 
	 * @var array $bootstrappers
	 */
	protected $bootstrappers = [
		\Syscodes\Core\Bootstrap\BootDetectEnvironment::class,
		\Syscodes\Core\Bootstrap\BootConfiguration::class,
		\Syscodes\Core\Bootstrap\BootHandleExceptions::class,
		\Syscodes\Core\Bootstrap\BootRegisterFacades::class,
		\Syscodes\Core\Bootstrap\BootRegisterProviders::class,
		\Syscodes\Core\Bootstrap\BootProviders::class,
	];

	/**
	 * Get the application's middleware.
	 * 
	 * @var array $middleware
	 */
	protected $middleware = [];

	/**
	 * Get the application's middleware groups.
	 * 
	 * @var array $middlewareGroups
	 */
	protected $middlewareGroups = [];

	/**
	 * The router instance.
	 * 
	 * @var \Syscodes\Routing\Router $router
	 */
	protected $router;

	/**
	 * Get the application's route middleware.
	 * 
	 * @var array $routeMiddleware
	 */
	protected $routeMiddleware = [];

	/**
	 * Total app execution time.
	 * 
	 * @var float $totalTime
	 */
	protected $totalTime;

	/**
	 * Constructor. Lenevor class instance.
	 * 
	 * @param  \Syscodes\Contracts\Core\Application  $app
	 * @param  \Syscodes\Routing\Router  $router
	 * 
	 * @return void
	 */
	public function __construct(Application $app, Router $router)
	{
		$this->app    = $app;
		$this->router = $router;

		$this->syncMiddlewareRoute();
	}
	 
	/**
	 * Initializes the framework, this can only be called once.
	 * Launch the application.
	 * 
	 * @param  \Syscodes\http\Request  $request
	 *
	 * @return \Syscodes\Http\Response
	 */
	public function handle($request)
	{
		try {
			$response = $this->sendRequestThroughRouter($request);
		} catch (Throwable $e) {
			$this->reportException($e);

			$response = $this->renderException($request, $e);
		}		

		return $response;
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
	}

	/**
	 * Send the given request through the router.
	 * 
	 * @param  \Syscodes\Http\Request  $request
	 * 
	 * @return \Syscodes\Http\Response
	 */
	protected function sendRequestThroughRouter($request)
	{
		$this->app->instance('request', $request);  

		Facade::clearResolvedInstance('request');

		// Load configuration system
		$this->bootstrap();

		return (new Pipeline($this->app))
				->send($request)
				->through($this->app->skipGoingMiddleware() ? [] : $this->middleware)
				->then($this->dispatchToRouter());
	}

	/**
	 * Bootstrap the application for HTTP requests.
	 * 
	 * @return void
	 */
	protected function bootstrap()
	{		
		if ( ! $this->app->hasBeenBootstrapped()) {
			$this->app->bootstrapWith($this->bootstrappers());
		}
	}

	/**
	 * Get the bootstrap classes for the application.
	 * 
	 * @return array
	 */
	protected function bootstrappers()
	{
		return $this->bootstrappers;
	}

	/**
	 * Sync the current state of the middleware to the router.
	 * 
	 * @return void
	 */
	protected function syncMiddlewareRoute()
	{
		foreach ($this->middlewareGroups as $key => $middleware) {
			$this->router->middlewareGroup($key, $middleware);
		}

		foreach ($this->routeMiddleware as $key => $middleware) {
			$this->router->aliasMiddleware($key, $middleware);
		}
	}

	/**
	 * Get the dispatcher of routes.
	 * 	  
	 * @return \Closure
 	 */
	protected function dispatchToRouter()
	{
		return function ($request) {
			$this->app->instance('request', $request);

			return $this->router->dispatch($request);
		};
	}

	/**
	 * Call the shutdown method on any terminable middleware.
	 * 
	 * @param  \Syscodes\Http\Request  $request
	 * @param  \Syscodes\Http\Response  $response
	 * 
	 * @return void
	 */
	public function shutdown($request, $response)
	{
		$this->shutdownMiddleware($request, $response);
	}

	/**
	 * Call the terminate method on any terminable middleware.
	 * 
	 * @param  \Syscodes\Http\Request  $request
	 * @param  \Syscodes\Http\Response  $response
	 * 
	 * @return void
	 */
	protected function shutdownMiddleware($request, $response)
	{
		$middlewares = $this->app->skipGoingMiddleware() ? [] : array_merge(
			$this->gatherRouteMiddleware($request),
			$this->middleware
		);

		foreach ($middlewares as $middleware) {
			if (! is_string($middleware)) {
				continue;
			}
			
			[$name] = $this->parseMiddleware($middleware);
			
			$instance = $this->app->make($name);
			
			if (method_exists($instance, 'shutdown')) {
				$instance->shutdown($request, $response);
			}
		}
	}

	/**
	 * Gather the route middleware for the given request.
	 * 
	 * @param  \Syscodes\Http\Request  $request
	 * 
	 * @return array
	 */
	protected function gatherRouteMiddleware($request)
	{
		if ( ! is_null($route = $request->route())) {
			return $this->router->gatherRouteMiddleware($route);
			return $this->router->gatherRouteMiddleware(/** @scrutinizer ignore-type */ $route);
		}

		return [];
	}
	
	/**
	 * Parse a middleware string to get the name and parameters.
	 * 
	 * @param  string  $middleware
	 * 
	 * @return array
	 */
	protected function parseMiddleware($middleware)
	{
		[$name, $parameters] = array_pad(explode(':', $middleware, 2), 2, []);
		
		if (is_string($parameters)) {
			$parameters = explode(',', $parameters);
		}
		
		return [$name, $parameters];
    }

	/**
	 * Report the exception to the exception handler.
	 * 
	 * @param  \Throwable  $e
	 * 
	 * @return void
	 */
	protected function reportException(Throwable $e)
	{
		return $this->app[ExceptionHandler::class]->report($e);
	}
	
	/**
	 * Render the exception to a response.
	 * 
	 * @param  \Syscodes\Http\Request  $request
	 * @param  \Throwable  $e
	 * 
	 * @return \Syscodes\Http\Response
	 */
	protected function renderException($request, Throwable $e)
	{
		return $this->app[ExceptionHandler::class]->render($request, $e);
	}
 }
lenevor / syscodes

Push — 0.7.0 ( e442b6...679d5f )

Lenevor::gatherRouteMiddleware() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
