Router::all() - Code Metrics - alphazframework/framework - Measure and Improve Code Quality continuously with Scrutinizer

Router::all() A
last analyzed 2023-12-15 04:26 UTC

↳ Parent: Router
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

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

/**
 * This file is part of the alphaz Framework.
 *
 * @author Muhammad Umer Farooq (Malik) <[email protected]>
 *
 * @link https://github.com/alphazframework/framework
 *
 * For the full copyright and license information, please view the LICENSE
 *  file that was distributed with this source code.
 * @since 1.0.0
 *
 * @license MIT
 *
 * @note i wrote this file first time by following the course on udemy  => https://www.udemy.com/php-mvc-from-scratch/ , any further/others modification by me
 */

namespace alphaz\Router;

use alphaz\Cache\Cache;
use alphaz\Data\Conversion;
use alphaz\http\Request;
use alphaz\http\Response;
use alphaz\Input\Input;
use alphaz\View\View;

class Router
{
    /**
     * Associative array of routes (the routing table).
     *
     * @since 1.0.0
     *
     * @var array
     */
    protected $routes = [];

    /**
     * Parameters from the matched route.
     *
     * @since 1.0.0
     *
     * @var array
     */
    protected $params = [];

    /**
     * Parameters from the matched route.
     *
     * @since 1.0.0
     *
     * @var array
     */
    private $request;


    /**
     * Parse the router.
     *
     * @param string $route The route URL
     *
     * @since 1.0.0
     *
     * @return string
     */
    protected function parseRoutes($route)
    {
        // Convert the route to a regular expression: escape forward slashes
        $route = preg_replace('/\//', '\\/', $route);
        // Convert variables e.g. {controller}
        $route = preg_replace('/\{([a-z]+)\}/', '(?P<\1>[a-z-]+)', $route);
        // Convert variables with custom regular expressions e.g. {id:\d+}
        $route = preg_replace('/\{([a-z]+):([^\}]+)\}/', '(?P<\1>\2)', $route);
        // Add start and end delimiters, and case insensitive flag
        return '/^'.$route.'$/i';
    }

    /**
     * Add a route to the routing table.
     *
     * @param string       $route      The route URL
     * @param array|string $params     Parameters (controller, action, etc.) or $params Home@index
     * @param string       $methods    request method like GET or GET|POST
     * @param string       $middleware Middleare name
     * @param array        $redirect   Redirect
     * @param mixed        $view       View
     *
     * @since 1.0.0
     *
     * @return void
     */
    public function add($route, $params = '', $methods = 'GET|HEAD', $middleware = '', $redirect = [], $view = null)
    {
        // Parse the route.
        $route = $this->parseRoutes($route);

        //If array
        if (is_array($params)) {
            $methodArray = ['method' => $methods];
            $params = array_merge($params, $methodArray);
            $this->routes[$route] = $params;
        } elseif (is_string($params)) {

            //If string
            if (!empty($params)) {
                $param = [];
                $parts = explode('@', $params);
                $param['controller'] = $parts[0];
                $param['action'] = $parts[1];
                if (isset($parts[2])) {
                    $param['namespace'] = $parts[2];
                }
            }
            $param['method'] = $methods;
            if (!empty($redirect)) {
                $param['redirect'] = true;
                $param['to'] = $redirect['to'];
                $param['code'] = $redirect['code'];
            }

            if (null != $view) {
                $param['view'] = $view['view'];
                $param['args'] = $view['args'];
            }

            //If middleware is set then used
            (!empty($middleware)) ? $param['middleware'] = $this->addMiddleware($middleware) : $param;
            $this->routes[$route] = $param;
        } elseif (is_callable($params)) {
            (!empty($middleware)) ? $this->routes[$route] = ['callable' => $params, 'method' => $methods, 'middleware' => $this->addMiddleware($middleware)] : $this->routes[$route] = ['callable' => $params, 'method' => $methods];
        } else {
            throw new \Exception('Wrong agruments given', 500);
        }
    }

    /**
     * Add the middleware.
     *
     * @param (string) $name name of middleware
     *
     * @since 1.0.0
     *
     * @return object
     */
    public function addMiddleware($name)
    {
        //Support middleware in comoponents
        //pattern => App\Components\Example\Middleware\@Example;
        $parts = explode('@', $name);
        if (strcasecmp($parts[0], $name) === 0) {
            //If namespace not givent then continue to defaukt
            $namespace = "App\Middleware\\";
            $middleware = $namespace.$name;
        } else {
            //If given then continue to provided namespace
            $namespace = $parts[0];
            $middleware = $namespace.$parts[1];
        }
        $middleware_object = new $middleware();
        if (class_exists($middleware)) {
            if (method_exists($middleware_object, 'before') && method_exists($middleware_object, 'after')) {
                return $middleware;

            } else {
                throw new \Exception('Middleware methods before and after not exists', 500);
            }
        } else {
            throw new \Exception("Middleware Class {$middleware} not found", 500);
        }
    }

    /**
     * Add multiple routes at once from array in the following format:.
     *
     * @param $routes = [route,param,method,middleware]

     *
     * @since 1.0.0
     *
     * @return void
     */
    public function addRoutes($routes)
    {
        if (!is_array($routes) && !$routes instanceof Traversable) {

            throw new \Exception('Routes should be an array or an instance of Traversable');
        }
        foreach ($routes as $route) {
            call_user_func_array([$this, 'add'], $route);
        }
    }

    /**
     * Add a route to the routing table as Redirect.
     *
     * @param string $route The route URL
     * @param string $to    Where you want to redirect
     * @param string $code  The HTTP code
     *
     * @since 1.0.0
     *
     * @return void
     */
    public function redirect($route, $to, $code = '301')
    {
        $this->add($route, '', 'GET', '', ['to' => $to, 'code' => $code]);
    }

    /**
     * Add a route to the routing table as POST.
     *
     * @param string       $route      The route URL
     * @param array|string $params     Parameters (controller, action, etc.) or $params Home@index
     * @param string       $middleware Middleare name
     *
     * @since 1.0.0
     *
     * @return void
     */
    public function post($route, $params, $middleware = '')
    {
        $this->add($route, $params, 'POST', $middleware);
    }

    /**
     * Add a route to the routing table as GET.
     *
     * @param string       $route      The route URL
     * @param array|string $params     Parameters (controller, action, etc.) or $params Home@index
     * @param string       $middleware Middleare name
     *
     * @since 1.0.0
     *
     * @return void
     */
    public function get($route, $params, $middleware = '')
    {
        $this->add($route, $params, 'GET|HEAD', $middleware);
    }

    /**
     * Add a route to the routing table as PUT.
     *
     * @param string       $route      The route URL
     * @param array|string $params     Parameters (controller, action, etc.) or $params Home@index
     * @param string       $middleware Middleare name
     *
     * @since 1.0.0
     *
     * @return void
     */
    public function put($route, $params, $middleware = '')
    {
        $this->add($route, $params, 'PUT', $middleware);
    }

    /**
     * Add a route to the routing table as PATCH.
     *
     * @param string       $route      The route URL
     * @param array|string $params     Parameters (controller, action, etc.) or $params Home@index
     * @param string       $middleware Middleare name
     *
     * @since 1.0.0
     *
     * @return void
     */
    public function patch($route, $params, $middleware = '')
    {
        $this->add($route, $params, 'PATCH', $middleware);
    }

    /**
     * Add a route to the routing table as DELETE.
     *
     * @param string       $route      The route URL
     * @param array|string $params     Parameters (controller, action, etc.) or $params Home@index
     * @param string       $middleware Middleare name
     *
     * @since 1.0.0
     *
     * @return void
     */
    public function delete($route, $params, $middleware = '')
    {
        $this->add($route, $params, 'DELETE', $middleware);
    }

    /**
     * Add a route to the routing table as OPTIONS.
     *
     * @param string       $route      The route URL
     * @param array|string $params     Parameters (controller, action, etc.) or $params Home@index
     * @param string       $middleware Middleare name
     *
     * @since 1.0.0
     *
     * @return void
     */
    public function options($route, $params, $middleware = '')
    {
        $this->add($route, $params, 'OPTIONS', $middleware);
    }

    /**
     * Add a route to the routing table as TRACE.
     *
     * @param string       $route      The route URL
     * @param array|string $params     Parameters (controller, action, etc.) or $params Home@index
     * @param string       $middleware Middleare name
     *
     * @since 1.0.0
     *
     * @return void
     */
    public function trace($route, $params, $middleware = '')
    {
        $this->add($route, $params, 'TRACE', $middleware);
    }

    /**
     * Add a route to the routing table as CONNECT.
     *
     * @param string       $route      The route URL
     * @param array|string $params     Parameters (controller, action, etc.) or $params Home@index
     * @param string       $middleware Middleare name
     *
     * @since 1.0.0
     *
     * @return void
     */
    public function connect($route, $params, $middleware = '')
    {
        $this->add($route, $params, 'CONNECT', $middleware);
    }

    /**
     * Add a route to the routing table as all method.
     *
     * @param string       $route      The route URL
     * @param array|string $params     Parameters (controller, action, etc.) or $params Home@index
     * @param string       $middleware Middleare name
     *
     * @since 1.0.0
     *
     * @return void
     */
    public function all($route, $params, $middleware = '')
    {
        $this->add($route, $params, 'GET|HEAD|POST|DELETE|OPTIONS|TRACE|PUT|PATCH|CONNECT', $middleware);
    }

    /**
     * Add a route to the routing table as view.
     *
     * @param string $route      The route URL
     * @param string $view       View File
     * @param array  $params     Parameters
     * @param string $middleware Middleare name
     * @param string $methods    request method like GET or GET|POST
     *
     * @since 1.0.0
     *
     * @return void
     */
    public function view($route, $view, $params = [], $method = 'GET', $middleware = '')
    {
        $this->add($route, '', $method, $middleware, null, ['view' => $view, 'args' => $params]);
    }

    /**
     * Get all the routes from the routing table.
     *
     * @since 1.0.0
     *
     * @return array
     */
    public function getRoutes()
    {
        return $this->routes;
    }

    /**
     * Match the route to the routes in the routing table, setting the $params
     * property if a route is found.
     *
     * @param string $url The route URL
     *
     * @since 1.0.0
     *
     * @return bool true if a match found, false otherwise
     */
    public function match($url)
    {
        foreach ($this->routes as $route => $params) {
            if (preg_match($route, $url, $matches)) {
                //Check if given method is matched
                if ($this->methodMatch($params['method'], null, new Request())) {
                    // Get named capture group values
                    foreach ($matches as $key => $match) {
                        if (is_string($key)) {
                            $params[$key] = $match;
                        }
                    }
                    $this->params = $params;

                    return true;
                }
            }
        }
    }

    /**
     * Match the request methods.
     *
     * @param string $methods       router request method
     * @param string $requestMethod Requested method
     *
     * @since 1.0.0
     *
     * @return bool
     */
    public function methodMatch($methods, $requestMethod, Request $request)
    {
        $match = false;
        if ($requestMethod === null) {

            $requestMethod = ($request->getRequestMethod()) ? $request->getRequestMethod() : 'GET';
        }
        $methods = explode('|', $methods);
        foreach ($methods as $method) {
            if (strcasecmp($requestMethod, $method) === 0) {
                $match = true;
                break;
            } else {
                continue;
            }
        }
        if ($match === true) {
            return true;
        }

        return false;
    }

    /**
     * Get the currently matched parameters.
     *
     * @since 1.0.0
     *
     * @return array
     */
    public function getParams()
    {
        return $this->params;
    }

    /**
     * Get the current input according to given method.
     *
     * @since 1.0.0
     *
     * @return mixed
     */
    public function getInput(Input $input)
    {
        $inputData = $input::inputAll();

        return (new Conversion())::arrayToObject($inputData);
        return (new Conversion())::arrayToObject(/** @scrutinizer ignore-type */ $inputData);
    }

    /**
     * Dispatch the route, creating the controller object and running the
     * action method.
     *
     * @param string $url The route URL
     *
     * @since 1.0.0
     *
     * @return void
     */
    public function dispatch(Request $request)
    {
        $url = $request->getQueryString();
        $url = $this->RemoveQueryString($url, new Request());
        $url = $this->RemoveQueryString(/** @scrutinizer ignore-type */ $url, new Request());
        if ($this->match($url)) {
            if (isset($this->params['redirect'])) {
                \alphaz\Site\Site::redirect($this->params['to'], $this->params['code']);
                                   redirect($this->params['to'], $this->params['code']);

                return;
            }

            if (isset($this->params['view'])) {
                return View::view($this->params['view'], $this->params['args']);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
            }
            (isset($this->params['middleware'])) ? $this->params['middleware'] = new $this->params['middleware']() : null;
            if (!isset($this->params['callable'])) {
                $controller = $this->params['controller'];
                $controller = $this->convertToStudlyCaps($controller);
                $controller = $this->getNamespace().$controller;
                if (class_exists($controller)) {
                    (isset($this->params['middleware']) && is_object($this->params['middleware'])) ? ( new $this->params['middleware']())->before(new Request(), new Response(), $this->params) : null;
                    $controller_object = new $controller($this->params, $this->getInput(new Input()));
                    $action = $this->params['action'];
                    $action = $this->convertToCamelCase($action);
                    if (preg_match('/action$/i', $action) == 0) {
                        $controller_object->$action();
                        (isset($this->params['middleware']) && is_object($this->params['middleware'])) ? (new $this->params['middleware']())->after(new Request(), new Response(), $this->params) : null;
                    } else {
                        throw new \Exception("Method $action in controller $controller cannot be called directly - remove the Action suffix to call this method");
                    }
                } else {
                    throw new \Exception("Controller class $controller not found");
                }
            } else {
                (is_object(isset($this->params['middleware']))) ? $this->params['middleware']->before(new Request(), new Response(), $this->params) : null;

                call_user_func($this->params['callable'], $this->params);
                (is_object(isset($this->params['middleware']))) ? $this->params['middleware']->after(new Request(), new Response(), $this->params) : null;

            }
        } else {
            \alphaz\Component\Router::loadComponents();
        }
    }

    /**
     * Convert the string with hyphens to StudlyCaps,.
     *
     * @param string $string The string to convert
     *
     * @since 1.0.0
     *
     * @return string
     */
    protected function convertToStudlyCaps($string)
    {
        return ucwords(str_replace('-', ' ', $string));
    }

    /**
     * Convert the string with hyphens to camelCase,.
     *
     * @param string $string The string to convert
     *
     * @since 1.0.0
     *
     * @return string
     */
    protected function convertToCamelCase($string)
    {
        return lcfirst($this->convertToStudlyCaps($string));
    }

    /**
     * Remove the query string variables from the URL (if any). As the full.
     *
     * @param string $url The full URL
     *
     * @since 1.0.0
     *
     * @return string The URL with the query string variables removed
     */
    protected function RemoveQueryString($url, Request $request)
    {
        if (isset($url) && !empty($url)) {
            $parts = explode('&', $url);

            if (strpos($parts[0], '=') === false) {
                $url = $parts[0];
            } else {
                $url = self::RemoveQueryString($request->getQueryString());
                $url = self::RemoveQueryString(/** @scrutinizer ignore-type */ $request->getQueryString());
            }
        }

        return $url;
    }

    /**
     * Get the namespace for the controller class. The namespace defined in the
     * route parameters is added if present.
     *
     * @param (string) $namespace valid namespace
     *
     * @since 1.0.0
     *
     * @return string The request URL
     */
    protected function getNamespace($namespace = null)
    {
        (!array_key_exists('namespace', $this->params)) ? $namespace = 'App\Controllers\\' : $namespace .= $this->params['namespace'].'\\';

        return $namespace;
    }

    /**
     * Parase the url if need.
     *
     * @since 1.0.0
     * @deprecated 3.0.0
     *
     * @return string The request URL
     */
    public function parseurl()
    {
        if (isset($_GET['url'])) {
            return $url = explode('/', filter_var(rtrim($_GET['url'], '/'), FILTER_SANITIZE_URL));

        }
    }

    /**
     * Load routers form cache.
     *
     * @since 1.0.0
     *
     * @return array
     */
    public function loadCache()
    {
        $cache = new Cache('file');
        if ($cache->has('router')) {
            return $cache->get('router');
        }
    }

    /**
     * Cache the roouter.
     *
     * @since 1.0.0
     *
     * @return void
     */
    public function cacheRouters()
    {
        if (__config('app.router_cache') === true) {

            $cache = new Cache('file');
            if (!$cache->has('router')) {
                $routers = $this->getRoutes();
                $cache->set('router', $routers, __config('app.router_cache_regenerate'));
            }
        }
    }
}

alphazframework / framework

Router::all() A last analyzed 2023-12-15 04:26 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Router::all() A
last analyzed 2023-12-15 04:26 UTC
