Router::collectDebugData() - Code Metrics - softberg/quantum-php-core - Measure and Improve Code Quality continuously with Scrutinizer

Router::collectDebugData() A
last analyzed 2025-05-22 08:49 UTC

↳ Parent: Router

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	2
eloc	4
nc	2
nop	1
dl	0
loc	9
rs	10
c	2
b	0
f	0

<?php

/**
 * Quantum PHP Framework
 *
 * An open source software development framework for PHP
 *
 * @package Quantum
 * @author Arman Ag. <[email protected]>
 * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
 * @link http://quantum.softberg.org/
 * @since 2.9.7
 */

namespace Quantum\Router;

use Quantum\App\Exceptions\StopExecutionException;
use Quantum\Libraries\ResourceCache\ViewCache;
use Quantum\Config\Exceptions\ConfigException;
use Quantum\Router\Exceptions\RouteException;
use Quantum\App\Exceptions\BaseException;
use Quantum\Di\Exceptions\DiException;
use DebugBar\DebugBarException;
use Quantum\Debugger\Debugger;
use Quantum\Http\Request;
use ReflectionException;

/**
 * Class Router
 * @package Quantum\Router
 */
class Router extends RouteController
{

    const VALID_PARAM_NAME_PATTERN = '/^[a-zA-Z]+$/';

    /**
     * Parameter types
     */
    const PARAM_TYPES = [
        ':alpha' => '[a-zA-Z]',
        ':num' => '[0-9]',
        ':any' => '[^\/]'
    ];

    /**
     * Request instance
     * @var Request;
     */
    private $request;

    /**
     * matched routes
     * @var array
     */
    private $matchedRoutes = [];

    /**
     * Router constructor.
     * @param Request $request
     */
    public function __construct(Request $request)
    {
        $this->request = $request;
    }

    /**
     * Finds the current route
     * @throws BaseException
     * @throws ConfigException
     * @throws DebugBarException
     * @throws DiException
     * @throws ReflectionException
     * @throws RouteException
     * @throws StopExecutionException
     */
    public function findRoute()
    {
        $uri = $this->request->getUri();

        if (!$uri) {
            throw RouteException::notFound();
        }

        $this->matchedRoutes = $this->findMatches($uri);

        if (empty($this->matchedRoutes)) {
            stop(function () {
                page_not_found();
            });
        }

        if (count($this->matchedRoutes) > 1) {
            $this->checkCollision();
        }

        $currentRoute = $this->currentRoute();

        if (!$currentRoute) {
            throw RouteException::incorrectMethod($this->request->getMethod());
        }

        $this->handleCaching($currentRoute);

        self::setCurrentRoute($currentRoute);

        info($this->collectDebugData($currentRoute), ['tab' => Debugger::ROUTES]);
    }

    /**
     * Resets the routes
     */
    public function resetRoutes()
    {
        parent::$currentRoute = null;
        $this->matchedRoutes = [];
    }

    /**
     * @param array $route
     * @return void
     */
    private function handleCaching(array $route): void
    {
        $viewCache = ViewCache::getInstance();

        $defaultCaching = $viewCache->isEnabled();

        $shouldCacheForRoute = $route['cache_settings']['shouldCache'] ?? $defaultCaching;

        $viewCache->enableCaching($shouldCacheForRoute);

        if ($shouldCacheForRoute && !empty($route['cache_settings']['ttl'])) {
            $viewCache->setTtl($route['cache_settings']['ttl']);
        }
    }

    /**
     * Gets the current route
     * @return array|null
     */
    private function currentRoute(): ?array
    {
        foreach ($this->matchedRoutes as $matchedRoute) {
            if ($this->checkMethod($matchedRoute)) {
                return $matchedRoute;
            }
        }

        return null;
    }

    /**
     * Collects debug data
     * @param array $currentRoute
     * @return array
     */
    private function collectDebugData(array $currentRoute): array
    {
        $routeInfo = [];

        foreach ($currentRoute as $key => $value) {
            $routeInfo[ucfirst($key)] = json_encode($value);
        }

        return $routeInfo;
    }

    /**
     * Finds matches by pattern
     * @param string $uri
     * @return array
     * @throws RouteException
     */
    private function findMatches(string $uri): array
    {
        $requestUri = urldecode(parse_url($uri, PHP_URL_PATH));

        $matches = [];

        foreach (self::$routes as $route) {
            list($pattern, $params) = $this->handleRoutePattern($route);

            if (preg_match("/^" . $this->escape($pattern) . "$/u", $requestUri, $matchedParams)) {
                $route['uri'] = $uri;
                $route['params'] = $this->routeParams($params, $matchedParams);
                $route['pattern'] = $pattern;
                $matches[] = $route;
            }
        }

        return $matches;
    }

    /**
     * Handles the route pattern
     * @param array $route
     * @return array
     * @throws RouteException
     */
    private function handleRoutePattern(array $route): array
    {
        $routeSegments = explode('/', trim($route['route'], '/'));

        $routePattern = '(\/)?';
        $routeParams = [];

        $lastIndex = (int)array_key_last($routeSegments);

        foreach ($routeSegments as $index => $segment) {
            $segmentParam = $this->getSegmentParam($segment, $index, $lastIndex);

            if (!empty($segmentParam)) {
                $this->checkParamName($routeParams, $segmentParam['name']);

                $routeParams[] = [
                    'route_pattern' => $segment,
                    'pattern' => $segmentParam['pattern'],
                    'name' => $segmentParam['name']
                ];

                $routePattern = $this->normalizePattern($routePattern, $segmentParam, $index, $lastIndex);
            } else {
                $routePattern .= $segment . ($index != $lastIndex ? '(\/)' : '');
            }
        }

        return [
            $routePattern,
            $routeParams
        ];
    }

    /**
     * Normalize the pattern
     * @param string $routePattern
     * @param array $segmentParam
     * @param int $index
     * @param int $lastIndex
     * @return string
     */
    private function normalizePattern(string $routePattern, array $segmentParam, int $index, int $lastIndex): string
    {
        if ($index == $lastIndex) {
            if (mb_substr($routePattern, -5) == '(\/)?') {
                $routePattern = mb_substr($routePattern, 0, mb_strlen($routePattern) - 5);
            } elseif (mb_substr($routePattern, -4) == '(\/)') {
                $routePattern = mb_substr($routePattern, 0, mb_strlen($routePattern) - 4);
            }
        }

        return $routePattern . $segmentParam['pattern'];
    }

    /**
     * Gets the route parameters
     * @param array $params
     * @param array $arguments
     * @return array
     */
    private function routeParams(array $params, array $arguments): array
    {
        $arguments = array_diff($arguments, ['', '/']);

        foreach ($params as &$param) {
            $param['value'] = $arguments[$param['name']] ?? null;
            if (mb_substr($param['name'], 0, 1) == '_') {
                $param['name'] = null;
            }
        }

        return $params;
    }

    /**
     * Checks the segment for parameter
     * @param string $segment
     * @param int $index
     * @param int $lastIndex
     * @return array
     * @throws RouteException
     */
    private function getSegmentParam(string $segment, int $index, int $lastIndex): array
    {
        foreach (self::PARAM_TYPES as $type => $expr) {
            if (preg_match('/\[(.*=)*(' . $type . ')(:([0-9]+))*\](\?)?/', $segment, $match)) {
                return $this->getParamPattern($match, $expr, $index, $lastIndex);
            }
        }

        return [];
    }

    /**
     * Checks the parameter name availability
     * @param array $routeParams
     * @param string $name
     * @throws RouteException
     */
    private function checkParamName(array $routeParams, string $name)
    {
        foreach ($routeParams as $param) {
            if ($param['name'] == $name) {
                throw RouteException::paramNameNotAvailable($name);
            }
        }
    }

    /**
     * Finds pattern for parameter
     * @param array $match
     * @param string $expr
     * @param int $index
     * @param int $lastIndex
     * @return array
     * @throws RouteException
     */
    private function getParamPattern(array $match, string $expr, int $index, int $lastIndex): array
    {
        $name = $this->getParamName($match, $index);

        $pattern = '(?<' . $name . '>' . $expr;

        if (isset($match[4]) && is_numeric($match[4])) {
            $pattern .= (isset($match[5]) && $match[5] == '?') ? '{0,' . $match[4] . '})' : '{' . $match[4] . '})';
        } else {
            $pattern .= (isset($match[5]) && $match[5] == '?') ? '*)' : '+)';
        }

        if (isset($match[5]) && $match[5] == '?') {
            $pattern = ($index == $lastIndex ? '(\/)?' . $pattern : $pattern . '(\/)?');
        } else {
            $pattern = ($index == $lastIndex ? '(\/)' . $pattern : $pattern . '(\/)');
        }

        return [
            'name' => $name,
            'pattern' => $pattern
        ];
    }

    /**
     * Gets the parameter name
     * @param array $match
     * @param int $index
     * @return string
     * @throws RouteException
     */
    private function getParamName(array $match, int $index): string
    {
        $name = $match[1] ? rtrim($match[1], '=') : null;

        if ($name === null) {
            return '_segment' . $index;
        }

        if (!preg_match(self::VALID_PARAM_NAME_PATTERN, $name)) {
            throw RouteException::paramNameNotValid();
        }

        return $name;
    }

    /**
     * Checks the route collisions
     * @throws RouteException
     */
    private function checkCollision()
    {
        $length = count($this->matchedRoutes);

        for ($i = 0; $i < $length - 1; $i++) {
            for ($j = $i + 1; $j < $length; $j++) {
                if ($this->matchedRoutes[$i]['method'] == $this->matchedRoutes[$j]['method']) {
                    throw RouteException::repetitiveRouteSameMethod($this->matchedRoutes[$j]['method']);
                }
                if ($this->matchedRoutes[$i]['module'] != $this->matchedRoutes[$j]['module']) {
                    throw RouteException::repetitiveRouteDifferentModules();
                }
            }
        }
    }

    /**
     * Checks the request method against defined route method
     * @param array $matchedRoute
     * @return bool
     */
    private function checkMethod(array $matchedRoute): bool
    {
        $allowedMethods = explode('|', $matchedRoute['method']);

        return in_array($this->request->getMethod(), $allowedMethods, true);
    }

    /**
     * Escapes the slashes
     * @param string $str
     * @return string
     */
    private function escape(string $str): string
    {
        return str_replace('/', '\/', stripslashes($str));
    }
}

1			<?php
2
3			/**
4			* Quantum PHP Framework
5			*
6			* An open source software development framework for PHP
7			*
8			* @package Quantum
9			* @author Arman Ag. <[email protected]>
10			* @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
11			* @link http://quantum.softberg.org/
12			* @since 2.9.7
13			*/
14
15			namespace Quantum\Router;
16
17			use Quantum\App\Exceptions\StopExecutionException;
18			use Quantum\Libraries\ResourceCache\ViewCache;
19			use Quantum\Config\Exceptions\ConfigException;
20			use Quantum\Router\Exceptions\RouteException;
21			use Quantum\App\Exceptions\BaseException;
22			use Quantum\Di\Exceptions\DiException;
23			use DebugBar\DebugBarException;
24			use Quantum\Debugger\Debugger;
25			use Quantum\Http\Request;
26			use ReflectionException;
27
28			/**
29			* Class Router
30			* @package Quantum\Router
31			*/
32			class Router extends RouteController
33			{
34
35			const VALID_PARAM_NAME_PATTERN = '/^[a-zA-Z]+$/';
36
37			/**
38			* Parameter types
39			*/
40			const PARAM_TYPES = [
41			':alpha' => '[a-zA-Z]',
42			':num' => '[0-9]',
43			':any' => '[^\/]'
44			];
45
46			/**
47			* Request instance
48			* @var Request;
49			*/
50			private $request;
51
52			/**
53			* matched routes
54			* @var array
55			*/
56			private $matchedRoutes = [];
57
58			/**
59			* Router constructor.
60			* @param Request $request
61			*/
62			public function __construct(Request $request)
63			{
64			$this->request = $request;
65			}
66
67			/**
68			* Finds the current route
69			* @throws BaseException
70			* @throws ConfigException
71			* @throws DebugBarException
72			* @throws DiException
73			* @throws ReflectionException
74			* @throws RouteException
75			* @throws StopExecutionException
76			*/
77			public function findRoute()
78			{
79			$uri = $this->request->getUri();
80
81			if (!$uri) {
82			throw RouteException::notFound();
83			}
84
85			$this->matchedRoutes = $this->findMatches($uri);
86
87			if (empty($this->matchedRoutes)) {
88			stop(function () {
89			page_not_found();
90			});
91			}
92
93			if (count($this->matchedRoutes) > 1) {
94			$this->checkCollision();
95			}
96
97			$currentRoute = $this->currentRoute();
98
99			if (!$currentRoute) {
100			throw RouteException::incorrectMethod($this->request->getMethod());
101			}
102
103			$this->handleCaching($currentRoute);
104
105			self::setCurrentRoute($currentRoute);
106
107			info($this->collectDebugData($currentRoute), ['tab' => Debugger::ROUTES]);
108			}
109
110			/**
111			* Resets the routes
112			*/
113			public function resetRoutes()
114			{
115			parent::$currentRoute = null;
116			$this->matchedRoutes = [];
117			}
118
119			/**
120			* @param array $route
121			* @return void
122			*/
123			private function handleCaching(array $route): void
124			{
125			$viewCache = ViewCache::getInstance();
126
127			$defaultCaching = $viewCache->isEnabled();
128
129			$shouldCacheForRoute = $route['cache_settings']['shouldCache'] ?? $defaultCaching;
130
131			$viewCache->enableCaching($shouldCacheForRoute);
132
133			if ($shouldCacheForRoute && !empty($route['cache_settings']['ttl'])) {
134			$viewCache->setTtl($route['cache_settings']['ttl']);
135			}
136			}
137
138			/**
139			* Gets the current route
140			* @return array\|null
141			*/
142			private function currentRoute(): ?array
143			{
144			foreach ($this->matchedRoutes as $matchedRoute) {
145			if ($this->checkMethod($matchedRoute)) {
146			return $matchedRoute;
147			}
148			}
149
150			return null;
151			}
152
153			/**
154			* Collects debug data
155			* @param array $currentRoute
156			* @return array
157			*/
158			private function collectDebugData(array $currentRoute): array
159			{
160			$routeInfo = [];
161
162			foreach ($currentRoute as $key => $value) {
163			$routeInfo[ucfirst($key)] = json_encode($value);
164			}
165
166			return $routeInfo;
167			}
168
169			/**
170			* Finds matches by pattern
171			* @param string $uri
172			* @return array
173			* @throws RouteException
174			*/
175			private function findMatches(string $uri): array
176			{
177			$requestUri = urldecode(parse_url($uri, PHP_URL_PATH));
178
179			$matches = [];
180
181			foreach (self::$routes as $route) {
182			list($pattern, $params) = $this->handleRoutePattern($route);
183
184			if (preg_match("/^" . $this->escape($pattern) . "$/u", $requestUri, $matchedParams)) {
185			$route['uri'] = $uri;
186			$route['params'] = $this->routeParams($params, $matchedParams);
187			$route['pattern'] = $pattern;
188			$matches[] = $route;
189			}
190			}
191
192			return $matches;
193			}
194
195			/**
196			* Handles the route pattern
197			* @param array $route
198			* @return array
199			* @throws RouteException
200			*/
201			private function handleRoutePattern(array $route): array
202			{
203			$routeSegments = explode('/', trim($route['route'], '/'));
204
205			$routePattern = '(\/)?';
206			$routeParams = [];
207
208			$lastIndex = (int)array_key_last($routeSegments);
209
210			foreach ($routeSegments as $index => $segment) {
211			$segmentParam = $this->getSegmentParam($segment, $index, $lastIndex);
212
213			if (!empty($segmentParam)) {
214			$this->checkParamName($routeParams, $segmentParam['name']);
215
216			$routeParams[] = [
217			'route_pattern' => $segment,
218			'pattern' => $segmentParam['pattern'],
219			'name' => $segmentParam['name']
220			];
221
222			$routePattern = $this->normalizePattern($routePattern, $segmentParam, $index, $lastIndex);
223			} else {
224			$routePattern .= $segment . ($index != $lastIndex ? '(\/)' : '');
225			}
226			}
227
228			return [
229			$routePattern,
230			$routeParams
231			];
232			}
233
234			/**
235			* Normalize the pattern
236			* @param string $routePattern
237			* @param array $segmentParam
238			* @param int $index
239			* @param int $lastIndex
240			* @return string
241			*/
242			private function normalizePattern(string $routePattern, array $segmentParam, int $index, int $lastIndex): string
243			{
244			if ($index == $lastIndex) {
245			if (mb_substr($routePattern, -5) == '(\/)?') {
246			$routePattern = mb_substr($routePattern, 0, mb_strlen($routePattern) - 5);
247			} elseif (mb_substr($routePattern, -4) == '(\/)') {
248			$routePattern = mb_substr($routePattern, 0, mb_strlen($routePattern) - 4);
249			}
250			}
251
252			return $routePattern . $segmentParam['pattern'];
253			}
254
255			/**
256			* Gets the route parameters
257			* @param array $params
258			* @param array $arguments
259			* @return array
260			*/
261			private function routeParams(array $params, array $arguments): array
262			{
263			$arguments = array_diff($arguments, ['', '/']);
264
265			foreach ($params as &$param) {
266			$param['value'] = $arguments[$param['name']] ?? null;
267			if (mb_substr($param['name'], 0, 1) == '_') {
268			$param['name'] = null;
269			}
270			}
271
272			return $params;
273			}
274
275			/**
276			* Checks the segment for parameter
277			* @param string $segment
278			* @param int $index
279			* @param int $lastIndex
280			* @return array
281			* @throws RouteException
282			*/
283			private function getSegmentParam(string $segment, int $index, int $lastIndex): array
284			{
285			foreach (self::PARAM_TYPES as $type => $expr) {
286			if (preg_match('/\[(.=)(' . $type . ')(:([0-9]+))*\](\?)?/', $segment, $match)) {
287			return $this->getParamPattern($match, $expr, $index, $lastIndex);
288			}
289			}
290
291			return [];
292			}
293
294			/**
295			* Checks the parameter name availability
296			* @param array $routeParams
297			* @param string $name
298			* @throws RouteException
299			*/
300			private function checkParamName(array $routeParams, string $name)
301			{
302			foreach ($routeParams as $param) {
303			if ($param['name'] == $name) {
304			throw RouteException::paramNameNotAvailable($name);
305			}
306			}
307			}
308
309			/**
310			* Finds pattern for parameter
311			* @param array $match
312			* @param string $expr
313			* @param int $index
314			* @param int $lastIndex
315			* @return array
316			* @throws RouteException
317			*/
318			private function getParamPattern(array $match, string $expr, int $index, int $lastIndex): array
319			{
320			$name = $this->getParamName($match, $index);
321
322			$pattern = '(?<' . $name . '>' . $expr;
323
324			if (isset($match[4]) && is_numeric($match[4])) {
325			$pattern .= (isset($match[5]) && $match[5] == '?') ? '{0,' . $match[4] . '})' : '{' . $match[4] . '})';
326			} else {
327			$pattern .= (isset($match[5]) && $match[5] == '?') ? '*)' : '+)';
328			}
329
330			if (isset($match[5]) && $match[5] == '?') {
331			$pattern = ($index == $lastIndex ? '(\/)?' . $pattern : $pattern . '(\/)?');
332			} else {
333			$pattern = ($index == $lastIndex ? '(\/)' . $pattern : $pattern . '(\/)');
334			}
335
336			return [
337			'name' => $name,
338			'pattern' => $pattern
339			];
340			}
341
342			/**
343			* Gets the parameter name
344			* @param array $match
345			* @param int $index
346			* @return string
347			* @throws RouteException
348			*/
349			private function getParamName(array $match, int $index): string
350			{
351			$name = $match[1] ? rtrim($match[1], '=') : null;
352
353			if ($name === null) {
354			return '_segment' . $index;
355			}
356
357			if (!preg_match(self::VALID_PARAM_NAME_PATTERN, $name)) {
358			throw RouteException::paramNameNotValid();
359			}
360
361			return $name;
362			}
363
364			/**
365			* Checks the route collisions
366			* @throws RouteException
367			*/
368			private function checkCollision()
369			{
370			$length = count($this->matchedRoutes);
371
372			for ($i = 0; $i < $length - 1; $i++) {
373			for ($j = $i + 1; $j < $length; $j++) {
374			if ($this->matchedRoutes[$i]['method'] == $this->matchedRoutes[$j]['method']) {
375			throw RouteException::repetitiveRouteSameMethod($this->matchedRoutes[$j]['method']);
376			}
377			if ($this->matchedRoutes[$i]['module'] != $this->matchedRoutes[$j]['module']) {
378			throw RouteException::repetitiveRouteDifferentModules();
379			}
380			}
381			}
382			}
383
384			/**
385			* Checks the request method against defined route method
386			* @param array $matchedRoute
387			* @return bool
388			*/
389			private function checkMethod(array $matchedRoute): bool
390			{
391			$allowedMethods = explode('\|', $matchedRoute['method']);
392
393			return in_array($this->request->getMethod(), $allowedMethods, true);
394			}
395
396			/**
397			* Escapes the slashes
398			* @param string $str
399			* @return string
400			*/
401			private function escape(string $str): string
402			{
403			return str_replace('/', '\/', stripslashes($str));
404			}
405			}

softberg / quantum-php-core

Router::collectDebugData() A last analyzed 2025-05-22 08:49 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Router::collectDebugData() A
last analyzed 2025-05-22 08:49 UTC