RouterCacheTrait::addRoute() - Code Metrics - Inspection of "Fix html id pb in acceptance" - phpMv/ubiquity - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( a4d3b7...39c189 )

by Jean-Christophe

created 2020-01-25 15:16 UTC

RouterCacheTrait::addRoute() A

↳ Parent: RouterCacheTrait

Complexity

Conditions	2
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

How to fix Many Parameters

<?php

namespace Ubiquity\cache\traits;

use Ubiquity\controllers\Startup;
use Ubiquity\controllers\Router;
use Ubiquity\cache\parser\ControllerParser;
use Ubiquity\cache\ClassUtils;
use Ubiquity\utils\base\UArray;
use Ubiquity\cache\CacheManager;
use Ubiquity\controllers\di\DiManager;
use Ubiquity\utils\base\UIntrospection;
use Ubiquity\controllers\Controller;
use Ubiquity\controllers\StartupAsync;

/**
 *
 * Ubiquity\cache\traits$RouterCacheTrait
 * This class is part of Ubiquity
 *
 * @author jcheron <[email protected]>
 * @version 1.0.8
 * @property \Ubiquity\cache\system\AbstractDataCache $cache
 *
 */
trait RouterCacheTrait {

	abstract protected static function _getFiles(&$config, $type, $silent = false);

	private static function addControllerCache($classname) {
		$parser = new ControllerParser ();
		try {
			$parser->parse ( $classname );
			return $parser->asArray ();
		} catch ( \Exception $e ) {
			// Nothing to do
		}
		return [ ];
	}

	private static function parseControllerFiles(&$config, $silent = false) {
		$routes = [ 'rest' => [ ],'default' => [ ] ];
		$files = self::getControllersFiles ( $config, $silent );
		foreach ( $files as $file ) {
			if (is_file ( $file )) {
				$controller = ClassUtils::getClassFullNameFromFile ( $file );
				$parser = new ControllerParser ();
				try {
					$parser->parse ( $controller );
					$ret = $parser->asArray ();
					$key = ($parser->isRest ()) ? 'rest' : 'default';
					$routes [$key] = \array_merge ( $routes [$key], $ret );
				} catch ( \Exception $e ) {
					// Nothing to do
				}
			}
		}
		self::sortByPriority ( $routes ['default'] );
		self::sortByPriority ( $routes ['rest'] );
		return $routes;
	}

	protected static function sortByPriority(&$array) {
		uasort ( $array, function ($item1, $item2) {
			return UArray::getRecursive ( $item2, 'priority', 0 ) <=> UArray::getRecursive ( $item1, 'priority', 0 );
		} );
		UArray::removeRecursive ( $array, 'priority' );
	}

	private static function initRouterCache(&$config, $silent = false) {
		$routes = self::parseControllerFiles ( $config, $silent );
		self::$cache->store ( 'controllers/routes.default', 'return ' . UArray::asPhpArray ( $routes ['default'], 'array' ) . ';', 'controllers' );
		self::$cache->store ( 'controllers/routes.rest', 'return ' . UArray::asPhpArray ( $routes ['rest'], 'array' ) . ';', 'controllers' );
		DiManager::init ( $config );
		if (! $silent) {
			echo "Router cache reset\n";
		}
	}

	public static function controllerCacheUpdated(&$config) {
		$result = false;
		$newRoutes = self::parseControllerFiles ( $config, true );
		$ctrls = self::getControllerCache ();
		if ($newRoutes ['default'] != $ctrls) {
			$result ['default'] = true;
		}
		$ctrls = self::getControllerCache ( true );
		if ($newRoutes ['rest'] != $ctrls) {
			$result ['rest'] = true;
		}
		return $result;
	}

	public static function storeDynamicRoutes($isRest = false) {
		$routes = Router::getRoutes ();
		$part = ($isRest) ? 'rest' : 'default';
		self::$cache->store ( 'controllers/routes.' . $part, 'return ' . UArray::asPhpArray ( $routes, 'array' ) . ';', 'controllers' );
	}

	private static function storeRouteResponse($key, $response) {
		self::$cache->store ( 'controllers/' . $key, $response, 'controllers', false );
		return $response;
	}

	private static function getRouteKey($routePath) {
		if (is_array ( $routePath )) {
			return 'path' . \md5 ( \implode ( '', $routePath ) );
		}
		return 'path' . \md5 ( Router::slashPath ( $routePath ) );
	}

	/**
	 *
	 * @param boolean $isRest
	 * @return array
	 */
	public static function getControllerCache($isRest = false) {
		$key = ($isRest) ? 'rest' : 'default';
		if (self::$cache->exists ( 'controllers/routes.' . $key ))
			return self::$cache->fetch ( 'controllers/routes.' . $key );
		return [ ];
	}

	public static function getRouteCache($routePath, $routeArray, $duration) {
		$key = self::getRouteKey ( $routePath );

		if (self::$cache->exists ( 'controllers/' . $key ) && ! self::expired ( $key, $duration )) {
			$response = self::$cache->file_get_contents ( 'controllers/' . $key );
			return $response;
		} else {
			$response = Startup::runAsString ( $routeArray );
			return self::storeRouteResponse ( $key, $response );
		}
	}

	protected static function expired($key, $duration) {
		return self::$cache->expired ( "controllers/" . $key, $duration ) === true;
	}

	public static function isExpired($routePath, $duration) {
		return self::expired ( self::getRouteKey ( $routePath ), $duration );
	}

	public static function setExpired($routePath) {
		$key = self::getRouteKey ( $routePath );
		if (self::$cache->exists ( 'controllers/' . $key )) {
			self::$cache->remove ( 'controllers/' . $key );
		}
	}

	public static function setRouteCache($routePath) {
		$key = self::getRouteKey ( $routePath );
		$response = Startup::runAsString ( $routePath );
		return self::storeRouteResponse ( $key, $response );
	}

	public static function addAdminRoutes() {
		self::addControllerCache ( 'Ubiquity\controllers\Admin' );
	}

	public static function getRoutes() {
		$result = self::getControllerCache ();
		return $result;
	}

	public static function getControllerRoutes($controllerClass, $isRest = false) {
		$result = [ ];
		$ctrlCache = self::getControllerCache ( $isRest );
		foreach ( $ctrlCache as $path => $routeAttributes ) {
			if (isset ( $routeAttributes ['controller'] )) {
				if ($routeAttributes ['controller'] === $controllerClass) {
					$result [$path] = $routeAttributes;
				}
			} else {
				$firstValue = current ( $routeAttributes );
				if (isset ( $firstValue ) && isset ( $firstValue ['controller'] )) {
					if ($firstValue ['controller'] === $controllerClass) {
						$result [$path] = $routeAttributes;
					}
				}
			}
		}
		return $result;
	}

	public static function addRoute($path, $controller, $action = 'index', $methods = null, $name = '', $isRest = false, $priority = 0, $callback = null) {
		$controllerCache = self::getControllerCache ( $isRest );
		Router::addRouteToRoutes ( $controllerCache, $path, $controller, $action, $methods, $name, false, null, [ ], $priority, $callback );
		self::$cache->store ( 'controllers/routes.' . ($isRest ? 'rest' : 'default'), "return " . UArray::asPhpArray ( $controllerCache, 'array' ) . ';', 'controllers' );
	}

	public static function addRoutes($pathArray, $controller, $action = 'index', $methods = null, $name = '') {
		self::addRoutes_ ( $pathArray, $controller, $action, $methods, $name, false );
	}

	public static function addRestRoutes($pathArray, $controller, $action = 'index', $methods = null, $name = '') {
		self::addRoutes_ ( $pathArray, $controller, $action, $methods, $name, true );
	}

	private static function addRoutes_($pathArray, $controller, $action = 'index', $methods = null, $name = '', $isRest = false) {
		$controllerCache = self::getControllerCache ( $isRest );
		$postfix = 'default';
		if ($isRest) {
			$postfix = 'rest';
		}
		Router::addRoutesToRoutes ( $controllerCache, $pathArray, $controller, $action, $methods, $name );
		self::$cache->store ( 'controllers/routes.' . $postfix, 'return ' . UArray::asPhpArray ( $controllerCache, 'array' ) . ';', 'controllers' );
	}

	public static function getControllersFiles(&$config, $silent = false) {
		return self::_getFiles ( $config, 'controllers', $silent );
	}

	public static function getControllers($subClass = "\\Ubiquity\\controllers\\Controller", $backslash = false, $includeSubclass = false, $includeAbstract = false) {
		$result = [ ];
		if ($includeSubclass) {
			$result [] = $subClass;
		}
		$config = Startup::getConfig ();
		$files = self::getControllersFiles ( $config, true );
		try {
			$restCtrls = CacheManager::getRestCache ();
		} catch ( \Exception $e ) {
			$restCtrls = [ ];
		}
		foreach ( $files as $file ) {
			if (is_file ( $file )) {
				$controllerClass = ClassUtils::getClassFullNameFromFile ( $file, $backslash );
				if (isset ( $restCtrls [$controllerClass] ) === false) {
					$r = new \ReflectionClass ( $controllerClass );
					if ($r->isSubclassOf ( $subClass ) && ($includeAbstract || ! $r->isAbstract ())) {
						$result [] = $controllerClass;
					}
				}
			}
		}
		return $result;
	}

	/**
	 * Preloads controllers.
	 * To use only with async servers (Swoole, Workerman)
	 *
	 * @param ?array $controllers
	 */
	public static function warmUpControllers($controllers = null) {
		$controllers = $controllers ?? self::getControllers ();
		foreach ( $controllers as $ctrl ) {
			$controller = StartupAsync::getControllerInstance ( $ctrl );
			$binary = UIntrospection::implementsMethod ( $controller, 'isValid', Controller::class ) ? 1 : 0;
			$binary += UIntrospection::implementsMethod ( $controller, 'initialize', Controller::class ) ? 2 : 0;
			$binary += UIntrospection::implementsMethod ( $controller, 'finalize', Controller::class ) ? 4 : 0;
			$controller->_binaryCalls = $binary;
		}
	}
}


1		<?php
2
3		namespace Ubiquity\cache\traits;
4
5		use Ubiquity\controllers\Startup;
6		use Ubiquity\controllers\Router;
7		use Ubiquity\cache\parser\ControllerParser;
8		use Ubiquity\cache\ClassUtils;
9		use Ubiquity\utils\base\UArray;
10		use Ubiquity\cache\CacheManager;
11		use Ubiquity\controllers\di\DiManager;
12		use Ubiquity\utils\base\UIntrospection;
13		use Ubiquity\controllers\Controller;
14		use Ubiquity\controllers\StartupAsync;
15
16		/**
17		*
18		* Ubiquity\cache\traits$RouterCacheTrait
19		* This class is part of Ubiquity
20		*
21		* @author jcheron <[email protected]>
22		* @version 1.0.8
23		* @property \Ubiquity\cache\system\AbstractDataCache $cache
24		*
25		*/
26		trait RouterCacheTrait {
27
28		abstract protected static function _getFiles(&$config, $type, $silent = false);
29
30		private static function addControllerCache($classname) {
31		$parser = new ControllerParser ();
32		try {
33		$parser->parse ( $classname );
34		return $parser->asArray ();
35		} catch ( \Exception $e ) {
36		// Nothing to do
37		}
38		return [ ];
39		}
40
41	17	private static function parseControllerFiles(&$config, $silent = false) {
42	17	$routes = [ 'rest' => [ ],'default' => [ ] ];
43	17	$files = self::getControllersFiles ( $config, $silent );
44	17	foreach ( $files as $file ) {
45	17	if (is_file ( $file )) {
46	17	$controller = ClassUtils::getClassFullNameFromFile ( $file );
47	17	$parser = new ControllerParser ();
48		try {
49	17	$parser->parse ( $controller );
50	17	$ret = $parser->asArray ();
51	17	$key = ($parser->isRest ()) ? 'rest' : 'default';
52	17	$routes [$key] = \array_merge ( $routes [$key], $ret );
53		} catch ( \Exception $e ) {
54		// Nothing to do
55		}
56		}
57		}
58	17	self::sortByPriority ( $routes ['default'] );
59	17	self::sortByPriority ( $routes ['rest'] );
60	17	return $routes;
61		}
62
63	17	protected static function sortByPriority(&$array) {
64		uasort ( $array, function ($item1, $item2) {
65	17	return UArray::getRecursive ( $item2, 'priority', 0 ) <=> UArray::getRecursive ( $item1, 'priority', 0 );
66	17	} );
67	17	UArray::removeRecursive ( $array, 'priority' );
68	17	}
69
70	8	private static function initRouterCache(&$config, $silent = false) {
71	8	$routes = self::parseControllerFiles ( $config, $silent );
72	8	self::$cache->store ( 'controllers/routes.default', 'return ' . UArray::asPhpArray ( $routes ['default'], 'array' ) . ';', 'controllers' );
73	8	self::$cache->store ( 'controllers/routes.rest', 'return ' . UArray::asPhpArray ( $routes ['rest'], 'array' ) . ';', 'controllers' );
74	8	DiManager::init ( $config );
75	8	if (! $silent) {
76	8	echo "Router cache reset\n";
77		}
78	8	}
79
80	11	public static function controllerCacheUpdated(&$config) {
81	11	$result = false;
82	11	$newRoutes = self::parseControllerFiles ( $config, true );
83	11	$ctrls = self::getControllerCache ();
84	11	if ($newRoutes ['default'] != $ctrls) {
85	6	$result ['default'] = true;
86		}
87	11	$ctrls = self::getControllerCache ( true );
88	11	if ($newRoutes ['rest'] != $ctrls) {
89	3	$result ['rest'] = true;
90		}
91	11	return $result;
92		}
93
94		public static function storeDynamicRoutes($isRest = false) {
95		$routes = Router::getRoutes ();
96		$part = ($isRest) ? 'rest' : 'default';
97		self::$cache->store ( 'controllers/routes.' . $part, 'return ' . UArray::asPhpArray ( $routes, 'array' ) . ';', 'controllers' );
98		}
99
100		private static function storeRouteResponse($key, $response) {
101		self::$cache->store ( 'controllers/' . $key, $response, 'controllers', false );
102		return $response;
103		}
104
105		private static function getRouteKey($routePath) {
106		if (is_array ( $routePath )) {
107		return 'path' . \md5 ( \implode ( '', $routePath ) );
108		}
109		return 'path' . \md5 ( Router::slashPath ( $routePath ) );
110		}
111
112		/**
113		*
114		* @param boolean $isRest
115		* @return array
116		*/
117	56	public static function getControllerCache($isRest = false) {
118	56	$key = ($isRest) ? 'rest' : 'default';
119	56	if (self::$cache->exists ( 'controllers/routes.' . $key ))
120	53	return self::$cache->fetch ( 'controllers/routes.' . $key );
121	4	return [ ];
122		}
123
124		public static function getRouteCache($routePath, $routeArray, $duration) {
125		$key = self::getRouteKey ( $routePath );
126
127		if (self::$cache->exists ( 'controllers/' . $key ) && ! self::expired ( $key, $duration )) {
128		$response = self::$cache->file_get_contents ( 'controllers/' . $key );
129		return $response;
130		} else {
131		$response = Startup::runAsString ( $routeArray );
132		return self::storeRouteResponse ( $key, $response );
133		}
134		}
135
136		protected static function expired($key, $duration) {
137		return self::$cache->expired ( "controllers/" . $key, $duration ) === true;
138		}
139
140		public static function isExpired($routePath, $duration) {
141		return self::expired ( self::getRouteKey ( $routePath ), $duration );
142		}
143
144		public static function setExpired($routePath) {
145		$key = self::getRouteKey ( $routePath );
146		if (self::$cache->exists ( 'controllers/' . $key )) {
147		self::$cache->remove ( 'controllers/' . $key );
148		}
149		}
150
151		public static function setRouteCache($routePath) {
152		$key = self::getRouteKey ( $routePath );
153		$response = Startup::runAsString ( $routePath );
154		return self::storeRouteResponse ( $key, $response );
155		}
156
157		public static function addAdminRoutes() {
158		self::addControllerCache ( 'Ubiquity\controllers\Admin' );
159		}
160
161	2	public static function getRoutes() {
162	2	$result = self::getControllerCache ();
163	2	return $result;
164		}
165
166	1	public static function getControllerRoutes($controllerClass, $isRest = false) {
167	1	$result = [ ];
168	1	$ctrlCache = self::getControllerCache ( $isRest );
169	1	foreach ( $ctrlCache as $path => $routeAttributes ) {
170	1	if (isset ( $routeAttributes ['controller'] )) {
171	1	if ($routeAttributes ['controller'] === $controllerClass) {
172	1	$result [$path] = $routeAttributes;
173		}
174		} else {
175	1	$firstValue = current ( $routeAttributes );
176	1	if (isset ( $firstValue ) && isset ( $firstValue ['controller'] )) {
177	1	if ($firstValue ['controller'] === $controllerClass) {
178	1	$result [$path] = $routeAttributes;
179		}
180		}
181		}
182		}
183	1	return $result;
184		}
185
186	1	public static function addRoute($path, $controller, $action = 'index', $methods = null, $name = '', $isRest = false, $priority = 0, $callback = null) {
187	1	$controllerCache = self::getControllerCache ( $isRest );
188	1	Router::addRouteToRoutes ( $controllerCache, $path, $controller, $action, $methods, $name, false, null, [ ], $priority, $callback );
189	1	self::$cache->store ( 'controllers/routes.' . ($isRest ? 'rest' : 'default'), "return " . UArray::asPhpArray ( $controllerCache, 'array' ) . ';', 'controllers' );
190	1	}
191
192		public static function addRoutes($pathArray, $controller, $action = 'index', $methods = null, $name = '') {
193		self::addRoutes_ ( $pathArray, $controller, $action, $methods, $name, false );
194		}
195
196		public static function addRestRoutes($pathArray, $controller, $action = 'index', $methods = null, $name = '') {
197		self::addRoutes_ ( $pathArray, $controller, $action, $methods, $name, true );
198		}
199
200		private static function addRoutes_($pathArray, $controller, $action = 'index', $methods = null, $name = '', $isRest = false) {
201		$controllerCache = self::getControllerCache ( $isRest );
202		$postfix = 'default';
203		if ($isRest) {
204		$postfix = 'rest';
205		}
206		Router::addRoutesToRoutes ( $controllerCache, $pathArray, $controller, $action, $methods, $name );
207		self::$cache->store ( 'controllers/routes.' . $postfix, 'return ' . UArray::asPhpArray ( $controllerCache, 'array' ) . ';', 'controllers' );
208		}
209
210	17	public static function getControllersFiles(&$config, $silent = false) {
211	17	return self::_getFiles ( $config, 'controllers', $silent );
212		}
213
214	10	public static function getControllers($subClass = "\\Ubiquity\\controllers\\Controller", $backslash = false, $includeSubclass = false, $includeAbstract = false) {
215	10	$result = [ ];
216	10	if ($includeSubclass) {
217	1	$result [] = $subClass;
218		}
219	10	$config = Startup::getConfig ();
220	10	$files = self::getControllersFiles ( $config, true );
221		try {
222	10	$restCtrls = CacheManager::getRestCache ();
223	2	} catch ( \Exception $e ) {
224	2	$restCtrls = [ ];
225		}
226	10	foreach ( $files as $file ) {
227	10	if (is_file ( $file )) {
228	10	$controllerClass = ClassUtils::getClassFullNameFromFile ( $file, $backslash );
229	10	if (isset ( $restCtrls [$controllerClass] ) === false) {
230	10	$r = new \ReflectionClass ( $controllerClass );
231	10	if ($r->isSubclassOf ( $subClass ) && ($includeAbstract \|\| ! $r->isAbstract ())) {
232	10	$result [] = $controllerClass;
233		}
234		}
235		}
236		}
237	10	return $result;
238		}
239
240		/**
241		* Preloads controllers.
242		* To use only with async servers (Swoole, Workerman)
243		*
244		* @param ?array $controllers
245		*/
246		public static function warmUpControllers($controllers = null) {
247		$controllers = $controllers ?? self::getControllers ();
248		foreach ( $controllers as $ctrl ) {
249		$controller = StartupAsync::getControllerInstance ( $ctrl );
250		$binary = UIntrospection::implementsMethod ( $controller, 'isValid', Controller::class ) ? 1 : 0;
251		$binary += UIntrospection::implementsMethod ( $controller, 'initialize', Controller::class ) ? 2 : 0;
252		$binary += UIntrospection::implementsMethod ( $controller, 'finalize', Controller::class ) ? 4 : 0;
253		$controller->_binaryCalls = $binary;
254		}
255		}
256		}
257

phpMv / ubiquity

Push — master ( a4d3b7...39c189 )

RouterCacheTrait::addRoute() A

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Many Parameters

Many Parameters

Duplication Side-by-Side

Filter issues like