Router::setStatusCode() - Code Metrics - Inspection of "Merge pull request #318 from phpMv/translations_do..." - phpMv/ubiquity - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( 28ea53...a47f4f )

by Jean-Christophe

created 2023-06-01 00:13 UTC

Router::setStatusCode() A

↳ Parent: Router

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
eloc	1
c	0
b	0
f	0
dl	0
loc	2
rs	10
ccs	0
cts	0
cp	0
cc	1
nc	1
nop	1
crap	2

<?php

namespace Ubiquity\controllers;

use Ubiquity\cache\CacheManager;
use Ubiquity\controllers\router\RouterStatus;
use Ubiquity\controllers\traits\RouterAdminTrait;
use Ubiquity\controllers\traits\RouterModifierTrait;
use Ubiquity\controllers\traits\RouterTestTrait;
use Ubiquity\log\Logger;
use Ubiquity\utils\http\URequest;

/**
 * Router manager.
 * Ubiquity\controllers$Router
 * This class is part of Ubiquity
 *
 * @author jcheron <[email protected]>
 * @version 1.1.1
 *
 */
class Router {
	use RouterModifierTrait, RouterAdminTrait, RouterTestTrait;

	protected static $routes;
	protected static $statusCode;

	private static function cleanParam(string $param): string {
		if (\substr($param, -1) === '/') {
			return \substr($param, 0, -1);
		}
		return $param;
	}

	private static function getRoute_(&$routeDetails, $routePath, $matches, $cachedResponse) {
		self::$statusCode = RouterStatus::OK;
		if (!isset ($routeDetails ['controller'])) {
			$method = \strtolower($_SERVER ['REQUEST_METHOD']);
			if (isset ($routeDetails [$method])) {
				$routeDetailsMethod = $routeDetails [$method];
				return self::getRouteUrlParts(['path' => $routePath, 'details' => $routeDetailsMethod], $matches, $routeDetailsMethod ['cache'] ?? false, $routeDetailsMethod ['duration'] ?? null, $cachedResponse);
			}
			self::$statusCode = RouterStatus::METHOD_NOT_ALLOWED;
		} else {
			return self::getRouteUrlParts(['path' => $routePath, 'details' => $routeDetails], $matches, $routeDetails ['cache'] ?? false, $routeDetails ['duration'] ?? null, $cachedResponse);
		}
		if (self::$statusCode === RouterStatus::OK) {
			self::$statusCode = RouterStatus::NOT_FOUND;
		}
		return false;
	}

	protected static function _getURL($routePath, $params) {
		$result = \preg_replace_callback('~\((.*?)\)~', function () use (&$params) {
			return \array_shift($params);
		}, $routePath);
		if (\count($params) > 0) {
			$result = \rtrim($result, '/') . '/' . \implode('/', $params);
		}
		return $result;
	}

	protected static function checkRouteName($routeDetails, $name) {
		if (!isset ($routeDetails ['name'])) {
			foreach ($routeDetails as $methodRouteDetail) {
				if (isset ($methodRouteDetail ['name']) && $methodRouteDetail ['name'] == $name) {
					return true;
				}
			}
		}
		return isset ($routeDetails ['name']) && $routeDetails ['name'] == $name;
	}

	protected static function setParamsInOrder($paramsOrder, $params) {
		$index = 0;
		$newParams = [];
		foreach ($paramsOrder as $order) {
			if ($order === '*') {
				if (isset ($params [$index])) {
					$newParams = \array_merge($newParams, \array_diff(\explode('/', $params [$index]), ['']));
				}
				break;
			}
			if (($order [0] ?? '') === '~') {
				$order = \intval(\substr($order, 1, 1));
				if (isset ($params [$order])) {
					$newParams = \array_merge($newParams, \array_diff(\explode('/', $params [$order]), ['']));
					break;
				}
			}
			$newParams [] = self::cleanParam($params [$order]);
			unset ($params [$order]);
			$index++;
		}
		return $newParams;
	}

	/**
	 * Starts the router by loading normal routes (not rest).
	 */
	public static function start(): void {
		self::$routes = CacheManager::getControllerCache();
	}

	/**
	 * Starts the router by loading rest routes (not normal routes).
	 */
	public static function startRest(): void {
		self::$routes = CacheManager::getControllerCache(true);
	}

	/**
	 * Starts the router by loading all routes (normal + rest routes).
	 */
	public static function startAll(): void {
		self::$routes = \array_merge(CacheManager::getControllerCache(), CacheManager::getControllerCache(true));
	}

	/**
	 * Returns the route corresponding to a path.
	 *
	 * @param string $path The route path
	 * @param boolean $cachedResponse
	 * @return boolean|mixed[]|string
	 */
	public static function getRoute($path, $cachedResponse = true, $debug = false) {
		$path = self::slashPath($path);
		if (isset (self::$routes [$path]) && !$debug) { // No direct access to route in debug mode (for maintenance mode activation)
			return self::getRoute_(self::$routes [$path], $path, [$path], $cachedResponse);
		}
		foreach (self::$routes as $routePath => $routeDetails) {
			if (\preg_match("@^{$routePath}\$@s", $path, $matches)) {
				if (($r = self::getRoute_($routeDetails, $routePath, $matches, $cachedResponse)) !== false) {
					return $r;
				}
			}
		}
		return false;
	}

	/**
	 * Returns the generated path from a route.
	 *
	 * @param string $name name of the route
	 * @param array $parameters array of the route parameters. default : []
	 * @param boolean $absolute
	 */
	public static function getRouteByName($name, $parameters = [], $absolute = true) {
		foreach (self::$routes as $routePath => $routeDetails) {
			if (self::checkRouteName($routeDetails, $name)) {
				if (\trim($routePath, '/') == '_default') {
					return ($absolute) ? '/' : '';
				}
				if (\count($parameters) > 0) {
					$routePath = self::_getURL($routePath, $parameters);
				}
				$routePath = \str_replace('//', '/', \preg_replace('~\((.*?)\)~', '', $routePath));
				return ($absolute) ? $routePath : \ltrim($routePath, '/');
			}
		}
		return false;
	}

	public static function getRouteInfoByName($name) {
		foreach (self::$routes as $routeDetails) {
			if (self::checkRouteName($routeDetails, $name)) {
				return $routeDetails;
			}
		}
		return false;
	}

	/**
	 * Returns the generated path from a route.
	 *
	 * @param string $name The route name
	 * @param array $parameters default: []
	 * @param boolean $absolute true if the path is absolute (/ at first)
	 * @return boolean|string|array|mixed the generated path (/path/to/route)
	 */
	public static function path($name, $parameters = [], $absolute = false) {
		return self::getRouteByName($name, $parameters, $absolute);
	}

	/**
	 * Returns the generated url from a route.
	 *
	 * @param string $name the route name
	 * @param array $parameters default: []
	 * @return string the generated url (http://myApp/path/to/route)
	 */
	public static function url($name, $parameters = []): string {
		return URequest::getUrl(self::getRouteByName($name, $parameters, false));
	}

	public static function getRouteUrlParts($routeArray, $params, $cached = false, $duration = null, $cachedResponse = true) {
		$realPath = \current($params);
		\array_shift($params);
		$routeDetails = $routeArray ['details'];
		if ($routeDetails ['controller'] instanceof \Closure) {
			$result = ['callback' => $routeDetails ['controller']];
			$resultStr = 'callable function';
		} else {
			$mainParams = null;
			if (($mainMethodParams = $routeDetails['main.params'] ?? null) !== null) {
				foreach ($mainMethodParams as $index => $mainMethodParam) {
					$mainParams[$mainMethodParam] = $params[$index];
				}
				$params = \array_slice($params, $index + 1);
			}
			$result = ['controller' => \str_replace("\\\\", "\\", $routeDetails ['controller']), 'action' => $routeDetails ['action'], 'mainParams' => $mainParams];
			$resultStr = \json_encode($result);
		}
		if (($paramsOrder = $routeDetails ['parameters']) && (\count($paramsOrder) > 0)) {
			$result['params'] = self::setParamsInOrder($paramsOrder, $params);
		}
		if (!$cached || !$cachedResponse) {
			Logger::info('Router', \sprintf('Route found for %s : %s', $routeArray ['path'], $resultStr), 'getRouteUrlParts');
			if (isset ($routeDetails ['callback'])) {
				// Used for maintenance mode
				if ($routeDetails ['callback'] instanceof \Closure) {
					return $routeDetails ['callback'] ($result);
				}
			}
			return $result;
		}
		Logger::info('Router', sprintf('Route found for %s (from cache) : %s', $realPath, $resultStr), 'getRouteUrlParts');
		return CacheManager::getRouteCache($realPath, $result, $duration);
	}

	/**
	 * Adds a slash before and after a path
	 *
	 * @param string $path The path to modify
	 * @return string The path with slashes
	 */
	public static function slashPath($path): string {
		if (\substr($path, 0, 1) !== '/') {
			$path = '/' . $path;
		}
		if (\substr($path, -1) !== '/') {
			$path = $path . '/';
		}
		return $path;
	}

	/**
	 * Declares a route as expired.
	 *
	 * @param string $routePath
	 */
	public static function setExpired($routePath): void {
		CacheManager::setExpired($routePath);
	}

	/**
	 * Returns the array of loaded routes.
	 *
	 * @return array|mixed
	 */
	public static function getRoutes() {
		return self::$routes;
	}

	/**
	 * Return router response status code.
	 * @return int
	 * @since 2.4.5
	 */
	public static function getStatusCode(): int {
		return self::$statusCode;
	}

	/**
	 * Set router response status code.
	 * @param mixed $statusCode
	 * @since 2.5.2
	 */
	public static function setStatusCode($statusCode): void {
		self::$statusCode = $statusCode;
	}
}


1		<?php
2
3		namespace Ubiquity\controllers;
4
5		use Ubiquity\cache\CacheManager;
6		use Ubiquity\controllers\router\RouterStatus;
7		use Ubiquity\controllers\traits\RouterAdminTrait;
8		use Ubiquity\controllers\traits\RouterModifierTrait;
9		use Ubiquity\controllers\traits\RouterTestTrait;
10		use Ubiquity\log\Logger;
11		use Ubiquity\utils\http\URequest;
12
13		/**
14		* Router manager.
15		* Ubiquity\controllers$Router
16		* This class is part of Ubiquity
17		*
18		* @author jcheron <[email protected]>
19		* @version 1.1.1
20		*
21		*/
22		class Router {
23		use RouterModifierTrait, RouterAdminTrait, RouterTestTrait;
24
25		protected static $routes;
26		protected static $statusCode;
27	16
28	16	private static function cleanParam(string $param): string {
29		if (\substr($param, -1) === '/') {
30		return \substr($param, 0, -1);
31	16	}
32		return $param;
33		}
34	36
35	36	private static function getRoute_(&$routeDetails, $routePath, $matches, $cachedResponse) {
36	36	self::$statusCode = RouterStatus::OK;
37	14	if (!isset ($routeDetails ['controller'])) {
38	14	$method = \strtolower($_SERVER ['REQUEST_METHOD']);
39	14	if (isset ($routeDetails [$method])) {
40	14	$routeDetailsMethod = $routeDetails [$method];
41		return self::getRouteUrlParts(['path' => $routePath, 'details' => $routeDetailsMethod], $matches, $routeDetailsMethod ['cache'] ?? false, $routeDetailsMethod ['duration'] ?? null, $cachedResponse);
42	3	}
43		self::$statusCode = RouterStatus::METHOD_NOT_ALLOWED;
44	23	} else {
45		return self::getRouteUrlParts(['path' => $routePath, 'details' => $routeDetails], $matches, $routeDetails ['cache'] ?? false, $routeDetails ['duration'] ?? null, $cachedResponse);
46	3	}
47		if (self::$statusCode === RouterStatus::OK) {
48		self::$statusCode = RouterStatus::NOT_FOUND;
49	3	}
50		return false;
51		}
52	4
53	4	protected static function _getURL($routePath, $params) {
54	4	$result = \preg_replace_callback('~\((.*?)\)~', function () use (&$params) {
55	4	return \array_shift($params);
56	4	}, $routePath);
57		if (\count($params) > 0) {
58		$result = \rtrim($result, '/') . '/' . \implode('/', $params);
59	4	}
60		return $result;
61		}
62	7
63	7	protected static function checkRouteName($routeDetails, $name) {
64	7	if (!isset ($routeDetails ['name'])) {
65	7	foreach ($routeDetails as $methodRouteDetail) {
66		if (isset ($methodRouteDetail ['name']) && $methodRouteDetail ['name'] == $name) {
67		return true;
68		}
69		}
70	7	}
71		return isset ($routeDetails ['name']) && $routeDetails ['name'] == $name;
72		}
73	18
74	18	protected static function setParamsInOrder($paramsOrder, $params) {
75	18	$index = 0;
76	18	$newParams = [];
77	18	foreach ($paramsOrder as $order) {
78	1	if ($order === '*') {
79	1	if (isset ($params [$index])) {
80		$newParams = \array_merge($newParams, \array_diff(\explode('/', $params [$index]), ['']));
81	1	}
82		break;
83	18	}
84	5	if (($order [0] ?? '') === '~') {
85	5	$order = \intval(\substr($order, 1, 1));
86	5	if (isset ($params [$order])) {
87	5	$newParams = \array_merge($newParams, \array_diff(\explode('/', $params [$order]), ['']));
88		break;
89		}
90	16	}
91	16	$newParams [] = self::cleanParam($params [$order]);
92	16	unset ($params [$order]);
93		$index++;
94	18	}
95		return $newParams;
96		}
97
98		/**
99		* Starts the router by loading normal routes (not rest).
100	44	*/
101	44	public static function start(): void {
102		self::$routes = CacheManager::getControllerCache();
103		}
104
105		/**
106		* Starts the router by loading rest routes (not normal routes).
107	5	*/
108	5	public static function startRest(): void {
109		self::$routes = CacheManager::getControllerCache(true);
110		}
111
112		/**
113		* Starts the router by loading all routes (normal + rest routes).
114	58	*/
115	58	public static function startAll(): void {
116		self::$routes = \array_merge(CacheManager::getControllerCache(), CacheManager::getControllerCache(true));
117		}
118
119		/**
120		* Returns the route corresponding to a path.
121		*
122		* @param string $path The route path
123		* @param boolean $cachedResponse
124		* @return boolean\|mixed[]\|string
125	71	*/
126	71	public static function getRoute($path, $cachedResponse = true, $debug = false) {
127	71	$path = self::slashPath($path);
128	5	if (isset (self::$routes [$path]) && !$debug) { // No direct access to route in debug mode (for maintenance mode activation)
129		return self::getRoute_(self::$routes [$path], $path, [$path], $cachedResponse);
130	70	}
131	70	foreach (self::$routes as $routePath => $routeDetails) {
132	33	if (\preg_match("@^{$routePath}\$@s", $path, $matches)) {
133	33	if (($r = self::getRoute_($routeDetails, $routePath, $matches, $cachedResponse)) !== false) {
134		return $r;
135		}
136		}
137	52	}
138		return false;
139		}
140
141		/**
142		* Returns the generated path from a route.
143		*
144		* @param string $name name of the route
145		* @param array $parameters array of the route parameters. default : []
146		* @param boolean $absolute
147	5	*/
148	5	public static function getRouteByName($name, $parameters = [], $absolute = true) {
149	5	foreach (self::$routes as $routePath => $routeDetails) {
150	5	if (self::checkRouteName($routeDetails, $name)) {
151		if (\trim($routePath, '/') == '_default') {
152		return ($absolute) ? '/' : '';
153	5	}
154	4	if (\count($parameters) > 0) {
155		$routePath = self::_getURL($routePath, $parameters);
156	5	}
157	5	$routePath = \str_replace('//', '/', \preg_replace('~\((.*?)\)~', '', $routePath));
158		return ($absolute) ? $routePath : \ltrim($routePath, '/');
159		}
160	3	}
161		return false;
162		}
163	2
164	2	public static function getRouteInfoByName($name) {
165	2	foreach (self::$routes as $routeDetails) {
166	2	if (self::checkRouteName($routeDetails, $name)) {
167		return $routeDetails;
168		}
169	1	}
170		return false;
171		}
172
173		/**
174		* Returns the generated path from a route.
175		*
176		* @param string $name The route name
177		* @param array $parameters default: []
178		* @param boolean $absolute true if the path is absolute (/ at first)
179		* @return boolean\|string\|array\|mixed the generated path (/path/to/route)
180	3	*/
181	3	public static function path($name, $parameters = [], $absolute = false) {
182		return self::getRouteByName($name, $parameters, $absolute);
183		}
184
185		/**
186		* Returns the generated url from a route.
187		*
188		* @param string $name the route name
189		* @param array $parameters default: []
190		* @return string the generated url (http://myApp/path/to/route)
191	1	*/
192	1	public static function url($name, $parameters = []): string {
193		return URequest::getUrl(self::getRouteByName($name, $parameters, false));
194		}
195	36
196	36	public static function getRouteUrlParts($routeArray, $params, $cached = false, $duration = null, $cachedResponse = true) {
197	36	$realPath = \current($params);
198	36	\array_shift($params);
199	36	$routeDetails = $routeArray ['details'];
200	1	if ($routeDetails ['controller'] instanceof \Closure) {
201	1	$result = ['callback' => $routeDetails ['controller']];
202		$resultStr = 'callable function';
203	35	} else {
204	35	$mainParams = null;
205	2	if (($mainMethodParams = $routeDetails['main.params'] ?? null) !== null) {
206	2	foreach ($mainMethodParams as $index => $mainMethodParam) {
207		$mainParams[$mainMethodParam] = $params[$index];
208	2	}
209		$params = \array_slice($params, $index + 1);
210	35	}
211	35	$result = ['controller' => \str_replace("\\\\", "\\", $routeDetails ['controller']), 'action' => $routeDetails ['action'], 'mainParams' => $mainParams];
212		$resultStr = \json_encode($result);
213	36	}
214	18	if (($paramsOrder = $routeDetails ['parameters']) && (\count($paramsOrder) > 0)) {
215		$result['params'] = self::setParamsInOrder($paramsOrder, $params);
216	36	}
217	36	if (!$cached \|\| !$cachedResponse) {
218	36	Logger::info('Router', \sprintf('Route found for %s : %s', $routeArray ['path'], $resultStr), 'getRouteUrlParts');
219		if (isset ($routeDetails ['callback'])) {
220	1	// Used for maintenance mode
221	1	if ($routeDetails ['callback'] instanceof \Closure) {
222		return $routeDetails ['callback'] ($result);
223		}
224	35	}
225		return $result;
226		}
227		Logger::info('Router', sprintf('Route found for %s (from cache) : %s', $realPath, $resultStr), 'getRouteUrlParts');
228		return CacheManager::getRouteCache($realPath, $result, $duration);
229		}
230
231		/**
232		* Adds a slash before and after a path
233		*
234		* @param string $path The path to modify
235		* @return string The path with slashes
236	74	*/
237	74	public static function slashPath($path): string {
238	72	if (\substr($path, 0, 1) !== '/') {
239		$path = '/' . $path;
240	74	}
241	70	if (\substr($path, -1) !== '/') {
242		$path = $path . '/';
243	74	}
244		return $path;
245		}
246
247		/**
248		* Declares a route as expired.
249		*
250		* @param string $routePath
251	1	*/
252	1	public static function setExpired($routePath): void {
253		CacheManager::setExpired($routePath);
254		}
255
256		/**
257		* Returns the array of loaded routes.
258		*
259		* @return array\|mixed
260	71	*/
261	71	public static function getRoutes() {
262		return self::$routes;
263		}
264
265		/**
266		* Return router response status code.
267		* @return int
268		* @since 2.4.5
269	1	*/
270	1	public static function getStatusCode(): int {
271		return self::$statusCode;
272		}
273
274		/**
275		* Set router response status code.
276		* @param mixed $statusCode
277		* @since 2.5.2
278		*/
279		public static function setStatusCode($statusCode): void {
280		self::$statusCode = $statusCode;
281		}
282		}
283

phpMv / ubiquity

Push — master ( 28ea53...a47f4f )

Router::setStatusCode() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like