Router::match() - Code Metrics - Inspection of "Fix PSR2" - HakimCh/Router - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 5629e4...fb54ee )

by Ch

created 2017-10-09 13:58 UTC

Router::match() B

↳ Parent: Router

Complexity

Conditions	4
Paths	6

Size

Total Lines	24
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	13
nc	6
nop	2
dl	0
loc	24
rs	8.6845
c	0
b	0
f	0

<?php
namespace HakimCh\Http;

use HakimCh\Http\Exception\RouterException;
use Traversable;

class Router
{
    protected $routes = [];
    protected $namedRoutes = [];
    protected $basePath = '';
    protected $all = ['get', 'post'];
    protected $server;
    /**
     * @var RouterParser
     */
    private $parser;

    /**
     * Create router in one call from config.
     *
     * @param RouterParser $parser
     * @param array $routes
     * @param string $basePath
     * @param array|null $server
     */
    public function __construct(RouterParser $parser, $routes = [], $basePath = '', $server = null)
    {
        $this->setRoutes($routes);
        $this->setBasePath($basePath);
        $this->parser = $parser;
        $this->server = $server;
    }

    /**
     * Map a route to a target
     *
     * @param string $method One of 5 HTTP Methods, or a pipe-separated list of multiple HTTP Methods (GET|POST|PATCH|PUT|DELETE)
     * @param string $route The route regex, custom regex must start with an @. You can use multiple pre-set regex filters, like [i:id]
     * @param mixed $target The target where this route should point to. Can be anything.
     * @param string $routeName Optional name of this route. Supply if you want to reverse route this url in your application.
     */
    public function map($method, $route, $target, $routeName = null)
    {
        if (is_string($routeName)) {
            $this->handleException($routeName, "Can not redeclare route '%s'", true);
            $this->namedRoutes[$routeName] = $route;
        }

        $this->routes[] = array($method, $route, $target, $routeName);
    }

    /**
     * Reversed routing
     *
     * Generate the URL for a named route. Replace regexes with supplied parameters
     *
     * @param string $routeName The name of the route.
     * @param array $params Associative array of parameters to replace placeholders with.
     * @return string The URL of the route with named parameters in place.
     */
    public function generate($routeName, array $params = [])
    {
        $this->handleException($routeName, "Route '%s' does not exist.", false);

        $route = $this->namedRoutes[$routeName];

        return $this->parser->generate($this->basePath, $route, $params);
    }

    /**
     * Match a given Request Url against stored routes
     * @param string $requestUrl
     * @param string $requestMethod
     * @return array|boolean Array with route information on success, false on failure (no match).
     */
    public function match($requestUrl = null, $requestMethod = null)
    {
        $requestUrl = $this->getRequestUrl($requestUrl);

        // set Request Method if it isn't passed as a parameter
        if (is_null($requestMethod)) {
            $requestMethod = $this->server['REQUEST_METHOD'];
        }

        foreach ($this->routes as $handler) {
            if (!$this->parser->methodMatch($handler[0], $requestMethod, $handler[1], $requestUrl)) {
                continue;
            }

            return array(
                'target' => $handler[2],
                'params' => array_filter($this->parser->getParams(), function ($k) {
                    return !is_numeric($k);
                }, ARRAY_FILTER_USE_KEY),
                'name'   => $handler[3]
            );
        }

        return false;
    }

    /**
     * @param $method
     * @param $arguments
     * @throws RouterException
     */
    public function __call($method, $arguments)
    {
        if (!in_array($method, array('get', 'post', 'delete', 'put', 'patch', 'update', 'all'))) {
            throw new RouterException($method . ' not exist in the '. __CLASS__);
        }

        $methods = $method == 'all' ? implode('|', $this->all) : $method;

        $route = array_merge([$methods], $arguments);

        call_user_func_array([$this, 'map'], $route);
    }

    /**
     * Retrieves all routes.
     * Useful if you want to process or display routes.
     * @return array All routes.
     */
    public function getRoutes()
    {
        return $this->routes;
    }

    /**
     * Add multiple routes at once from array in the following format:
     *
     *   $routes = array(
     *      array($method, $route, $target, $name)
     *   );
     *
     * @param array|Traversable $routes
     * @return void
     * @author Koen Punt
     */
    public function setRoutes($routes)
    {
        if (!is_array($routes) && !$routes instanceof Traversable) {
            throw new RouterException('Routes should be an array or an instance of Traversable');
        }
        if (!empty($routes)) {
            foreach ($routes as $route) {
                call_user_func_array(array($this, 'map'), $route);
            }
        }
    }

    /**
     * Set the base path.
     * Useful if you are running your application from a subdirectory.
     */
    public function setBasePath($basePath)
    {
        $this->basePath = $basePath;
    }

    /**
     * @param $routeName
     * @param $message
     * @param bool $cmpTo
     * @throws RouterException
     */
    private function handleException($routeName, $message, $cmpTo)
    {
        if (array_key_exists($routeName, $this->namedRoutes) === $cmpTo) {
            throw new RouterException(sprintf($message, $routeName));
        }
    }

    /**
     * @param $requestUrl
     *
     * @return mixed
     */
    private function getRequestUrl($requestUrl = null)
    {
        // set Request Url if it isn't passed as parameter
        if (is_null($requestUrl)) {
            $requestUrl = parse_url($this->server['REQUEST_URI'], PHP_URL_PATH);
        }

        return str_replace($this->basePath, '', strtok($requestUrl, '?'));
    }

    public function getParser()
    {
        return $this->parser;
    }
}


1			<?php
2			namespace HakimCh\Http;
3
4			use HakimCh\Http\Exception\RouterException;
5			use Traversable;
6
7			class Router
8			{
9			protected $routes = [];
10			protected $namedRoutes = [];
11			protected $basePath = '';
12			protected $all = ['get', 'post'];
13			protected $server;
14			/**
15			* @var RouterParser
16			*/
17			private $parser;
18
19			/**
20			* Create router in one call from config.
21			*
22			* @param RouterParser $parser
23			* @param array $routes
24			* @param string $basePath
25			* @param array\|null $server
26			*/
27			public function __construct(RouterParser $parser, $routes = [], $basePath = '', $server = null)
28			{
29			$this->setRoutes($routes);
30			$this->setBasePath($basePath);
31			$this->parser = $parser;
32			$this->server = $server;
33			}
34
35			/**
36			* Map a route to a target
37			*
38			* @param string $method One of 5 HTTP Methods, or a pipe-separated list of multiple HTTP Methods (GET\|POST\|PATCH\|PUT\|DELETE)
39			* @param string $route The route regex, custom regex must start with an @. You can use multiple pre-set regex filters, like [i:id]
40			* @param mixed $target The target where this route should point to. Can be anything.
41			* @param string $routeName Optional name of this route. Supply if you want to reverse route this url in your application.
42			*/
43			public function map($method, $route, $target, $routeName = null)
44			{
45			if (is_string($routeName)) {
46			$this->handleException($routeName, "Can not redeclare route '%s'", true);
47			$this->namedRoutes[$routeName] = $route;
48			}
49
50			$this->routes[] = array($method, $route, $target, $routeName);
51			}
52
53			/**
54			* Reversed routing
55			*
56			* Generate the URL for a named route. Replace regexes with supplied parameters
57			*
58			* @param string $routeName The name of the route.
59			* @param array $params Associative array of parameters to replace placeholders with.
60			* @return string The URL of the route with named parameters in place.
61			*/
62			public function generate($routeName, array $params = [])
63			{
64			$this->handleException($routeName, "Route '%s' does not exist.", false);
65
66			$route = $this->namedRoutes[$routeName];
67
68			return $this->parser->generate($this->basePath, $route, $params);
69			}
70
71			/**
72			* Match a given Request Url against stored routes
73			* @param string $requestUrl
74			* @param string $requestMethod
75			* @return array\|boolean Array with route information on success, false on failure (no match).
76			*/
77			public function match($requestUrl = null, $requestMethod = null)
78			{
79			$requestUrl = $this->getRequestUrl($requestUrl);
80
81			// set Request Method if it isn't passed as a parameter
82			if (is_null($requestMethod)) {
83			$requestMethod = $this->server['REQUEST_METHOD'];
84			}
85
86			foreach ($this->routes as $handler) {
87			if (!$this->parser->methodMatch($handler[0], $requestMethod, $handler[1], $requestUrl)) {
88			continue;
89			}
90
91			return array(
92			'target' => $handler[2],
93			'params' => array_filter($this->parser->getParams(), function ($k) {
94			return !is_numeric($k);
95			}, ARRAY_FILTER_USE_KEY),
96			'name' => $handler[3]
97			);
98			}
99
100			return false;
101			}
102
103			/**
104			* @param $method
105			* @param $arguments
106			* @throws RouterException
107			*/
108			public function __call($method, $arguments)
109			{
110			if (!in_array($method, array('get', 'post', 'delete', 'put', 'patch', 'update', 'all'))) {
111			throw new RouterException($method . ' not exist in the '. __CLASS__);
112			}
113
114			$methods = $method == 'all' ? implode('\|', $this->all) : $method;
115
116			$route = array_merge([$methods], $arguments);
117
118			call_user_func_array([$this, 'map'], $route);
119			}
120
121			/**
122			* Retrieves all routes.
123			* Useful if you want to process or display routes.
124			* @return array All routes.
125			*/
126			public function getRoutes()
127			{
128			return $this->routes;
129			}
130
131			/**
132			* Add multiple routes at once from array in the following format:
133			*
134			* $routes = array(
135			* array($method, $route, $target, $name)
136			* );
137			*
138			* @param array\|Traversable $routes
139			* @return void
140			* @author Koen Punt
141			*/
142			public function setRoutes($routes)
143			{
144			if (!is_array($routes) && !$routes instanceof Traversable) {
145			throw new RouterException('Routes should be an array or an instance of Traversable');
146			}
147			if (!empty($routes)) {
148			foreach ($routes as $route) {
149			call_user_func_array(array($this, 'map'), $route);
150			}
151			}
152			}
153
154			/**
155			* Set the base path.
156			* Useful if you are running your application from a subdirectory.
157			*/
158			public function setBasePath($basePath)
159			{
160			$this->basePath = $basePath;
161			}
162
163			/**
164			* @param $routeName
165			* @param $message
166			* @param bool $cmpTo
167			* @throws RouterException
168			*/
169			private function handleException($routeName, $message, $cmpTo)
170			{
171			if (array_key_exists($routeName, $this->namedRoutes) === $cmpTo) {
172			throw new RouterException(sprintf($message, $routeName));
173			}
174			}
175
176			/**
177			* @param $requestUrl
178			*
179			* @return mixed
180			*/
181			private function getRequestUrl($requestUrl = null)
182			{
183			// set Request Url if it isn't passed as parameter
184			if (is_null($requestUrl)) {
185			$requestUrl = parse_url($this->server['REQUEST_URI'], PHP_URL_PATH);
186			}
187
188			return str_replace($this->basePath, '', strtok($requestUrl, '?'));
189			}
190
191			public function getParser()
192			{
193			return $this->parser;
194			}
195			}
196

HakimCh / Router

Push — master ( 5629e4...fb54ee )

Router::match() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like