Selami\Router

Complexity

Total Complexity

15

Size/Duplication

Total Lines	172
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	extractFolder()	0	10	3
A	dispatcher()	0	15	1
A	addRoutes()	0	12	3
A	getAliases()	0	10	3
A	getRoute()	0	10	1
A	runDispatcher()	0	16	1
A	getRouteData()	0	15	2

<?php
/**
 * Selami Router
 *
 * @link      https://github.com/selamiphp/router
 * @license   https://github.com/selamiphp/router/blob/master/LICENSE (MIT License)
 */
namespace Selami;

use FastRoute;
/**
 * Router
 *
 * This class is responsible for registering route objects,
 * determining aliases if available and finding requested route
 */
final class Router
{
    /**
     * routes array to be registered.
     * Each route item is an array has items respectively : Request Method, Request Uri, Controller/Action, Return Type.
     * Route item can be defined using array key as an alias key.
     * @var array
     */
    private $routes = [];

    /**
     * HTTP request Method
     * @var string
     */
    private $method = null;

    /**
     * Request Uri
     * @var string
     */
    private $requestedPath = null;

    /**
     * Default return type if not noted in the $routes
     * @var string
     */
    private $defaultReturnType = null;

    /**
     * Router constructor.
     * Create new router.
     *
     * @param array $routes
     * @param string $defaultReturnType
     * @param string $method
     * @param string $requestedPath
     * @param string $folder
     */
    public function __construct(array $routes, string $defaultReturnType, string $method, string $requestedPath, string $folder='')
    {
        $this->routes   = $routes;
        $this->method   = $method;
        $this->requestedPath     = $this->extractFolder($requestedPath, $folder);
        $this->defaultReturnType = $defaultReturnType;
    }

    /**
     * Remove subfolder from requestedPath if defined
     * @param $requestPath
     * @param $folder
     * @return string
     */
    private function extractFolder($requestPath, $folder)
    {
        if (!empty($folder)) {
            $requestPath = '/' . trim(preg_replace('#^/' . $folder . '#msi', '/', $requestPath), "/");
        }
        if($requestPath == ''){
            $requestPath = '/';
        }
        return $requestPath;
    }

    /**
     * Dispatch against the provided HTTP method verb and URI.
     * @return array
     */
    private function dispatcher()
    {
        $options = [
            'routeParser'   => 'FastRoute\\RouteParser\\Std',
            'dataGenerator' => 'FastRoute\\DataGenerator\\GroupCountBased',
            'dispatcher'    => 'FastRoute\\Dispatcher\\GroupCountBased',
            'routeCollector' => 'FastRoute\\RouteCollector',
        ];
        /** @var RouteCollector $routeCollector */
        $routeCollector = new $options['routeCollector'](
            new $options['routeParser'], new $options['dataGenerator']
        );
        $this->addRoutes($routeCollector);
        return new $options['dispatcher']($routeCollector->getData());
    }

    /**
     * Define Closures for all routes that returns controller info to be used.
     * @param FastRoute\RouteCollector $route
     */
    private function addRoutes(FastRoute\RouteCollector $route)
    {
        foreach ($this->routes as $definedRoute) {
            $definedRoute[3] = (isset($definedRoute[3])) ? $definedRoute[3] : $this->defaultReturnType;
            $route->addRoute(strtoupper($definedRoute[0]), $definedRoute[1], function($args) use($definedRoute) {
                $returnType = $definedRoute[3];
                $controller = $definedRoute[2];
                list($definedRoute, $action) = explode("/", $controller);
                return  ['definedRoute' => $definedRoute, 'action'=> $action, 'returnType'=> $returnType, 'args'=> $args];
            });
        }
    }

    /**
     * Get aliases and request uri from $routes
     * @return array
     */
    private function getAliases()
    {
        $aliases = [];
        foreach ($this->routes as $alias=>$value) {
            if (gettype($alias) == 'string') {
                $aliases[$alias] = $value[1];
            }
        }
        return $aliases;
    }

    /**
     * Get router data that includes route info and aliases
     */
    public function getRoute()
    {
        $dispatcher = $this->dispatcher();
        $routeInfo  = $dispatcher->dispatch($this->method, $this->requestedPath);
        $routerData = [
            'route'     => $this->runDispatcher($routeInfo),
            'aliases'   => $this->getAliases()
        ];
        return $routerData;
    }

    /**
     * Get route info for requested uri
     * @param array $routeInfo
     * @return array $routerData
     */
    private function runDispatcher(array $routeInfo)
    {
        $routeData = $this->getRouteData($routeInfo);
        $dispatchResults = [
            FastRoute\Dispatcher::METHOD_NOT_ALLOWED => [
                'status' => 405
            ],
            FastRoute\Dispatcher::FOUND => [
                'status'  => 200
            ],
            FastRoute\Dispatcher::NOT_FOUND => [
                'status' => 404
            ]
        ];
        return array_merge($routeData, $dispatchResults[$routeInfo[0]]);
    }

    /**
     * Get routeData according to dispatcher's results
     * @param array $routeInfo
     * @return array
     */
    private function getRouteData(array $routeInfo)
    {
        if ($routeInfo[0] === FastRoute\Dispatcher::FOUND) {
            $handler = $routeInfo[1];
            $vars  = $routeInfo[2];
            return $handler($vars);
        }
        return [
            'status'        => 200,
            'returnType'    => 'html',
            'definedRoute'    => null,
            'action'        => null,
            'args'          => []
        ];
    }
}