RouterCacheTrait::getControllers() - Code Metrics - Inspection of "Controller list (isSuclass....)" - phpMv/ubiquity - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0a01fe...765122 )

by Jean-Christophe

created 2018-04-24 00:40 UTC

RouterCacheTrait::getControllers() C

↳ Parent: RouterCacheTrait

Complexity

Conditions	7
Paths	10

Size

Total Lines	22
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	22
rs	6.9811
c	0
b	0
f	0
cc	7
eloc	16
nc	10
nop	0

<?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;

/**
 *
 * @author jc
 * @staticvar array $cache
 *
 */
trait RouterCacheTrait{

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

	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 initRouterCache(&$config, $silent=false) {
		$routes=[ "rest" => [ ],"default" => [ ] ];
		$files=self::getControllersFiles($config);
		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::$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');
		if (!$silent) {
			echo "Router cache reset\n";
		}
	}

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

	private static function getRouteKey($routePath) {
		return "path" . \md5(\implode("", $routePath));
	}

	private static function setKeyExpired($key, $expired=true) {
		if ($expired) {
			self::$expiredRoutes[$key]=true;
		} else {
			unset(self::$expiredRoutes[$key]);
		}
	}

	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, $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($routePath);
			return self::storeRouteResponse($key, $response);
		}
	}

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

	public static function isExpired($path, $duration) {
		$route=Router::getRoute($path, false);
		if ($route !== false && \is_array($route)) {
			return self::expired(self::getRouteKey($route), $duration);
		}
		return true;
	}

	public static function setExpired($routePath, $expired=true) {
		$key=self::getRouteKey($routePath);
		self::setKeyExpired($key, $expired);
	}

	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=reset($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="") {
		$controllerCache=self::getControllerCache();
		Router::addRouteToRoutes($controllerCache, $path, $controller, $action, $methods, $name);
		self::$cache->store("controllers/routes", "return " . UArray::asPhpArray($controllerCache, "array") . ";", 'controllers');
	}

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

	public static function getControllers() {
		$result=[ ];
		$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);
				if (isset($restCtrls[$controllerClass]) === false) {
					$r=new \ReflectionClass($controllerClass);
					if($r->isSubclassOf("Ubiquity\\controllers\Controller") && !$r->isAbstract()){
						$result[]=$controllerClass;
					}
				}
			}
		}
		return $result;
	}
}


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
12			/**
13			*
14			* @author jc
15			* @staticvar array $cache
16			*
17			*/
18			trait RouterCacheTrait{
19
20			abstract protected static function _getFiles(&$config, $type, $silent=false);
21			private static $expiredRoutes=[ ];
22
23			private static function addControllerCache($classname) {
24			$parser=new ControllerParser();
25			try {
26			$parser->parse($classname);
27			return $parser->asArray();
28			} catch ( \Exception $e ) {
29			// Nothing to do
30			}
31			return [ ];
32			}
33
34			private static function initRouterCache(&$config, $silent=false) {
35			$routes=[ "rest" => [ ],"default" => [ ] ];
36			$files=self::getControllersFiles($config);
37			foreach ( $files as $file ) {
38			if (is_file($file)) {
39			$controller=ClassUtils::getClassFullNameFromFile($file);
40			$parser=new ControllerParser();
41			try {
42			$parser->parse($controller);
43			$ret=$parser->asArray();
44			$key=($parser->isRest()) ? "rest" : "default";
45			$routes[$key]=\array_merge($routes[$key], $ret);
46			} catch ( \Exception $e ) {
47			// Nothing to do
48			}
49			}
50			}
51			self::$cache->store("controllers/routes.default", "return " . UArray::asPhpArray($routes["default"], "array") . ";", 'controllers');
52			self::$cache->store("controllers/routes.rest", "return " . UArray::asPhpArray($routes["rest"], "array") . ";", 'controllers');
53			if (!$silent) {
54			echo "Router cache reset\n";
55			}
56			}
57
58			private static function storeRouteResponse($key, $response) {
59			self::setKeyExpired($key, false);
60			self::$cache->store("controllers/" . $key, $response, 'controllers', false);
61			return $response;
62			}
63
64			private static function getRouteKey($routePath) {
65			return "path" . \md5(\implode("", $routePath));
66			}
67
68			private static function setKeyExpired($key, $expired=true) {
69			if ($expired) {
70			self::$expiredRoutes[$key]=true;
71			} else {
72			unset(self::$expiredRoutes[$key]);
73			}
74			}
75
76			public static function getControllerCache($isRest=false) {
77			$key=($isRest) ? "rest" : "default";
78			if (self::$cache->exists("controllers/routes." . $key))
79			return self::$cache->fetch("controllers/routes." . $key);
80			return [ ];
81			}
82
83			public static function getRouteCache($routePath, $duration) {
84			$key=self::getRouteKey($routePath);
85
86			if (self::$cache->exists("controllers/" . $key) && !self::expired($key, $duration)) {
87			$response=self::$cache->file_get_contents("controllers/" . $key);
88			return $response;
89			} else {
90			$response=Startup::runAsString($routePath);
91			return self::storeRouteResponse($key, $response);
92			}
93			}
94
95			public static function expired($key, $duration) {
96			return self::$cache->expired("controllers/" . $key, $duration) === true \|\| \array_key_exists($key, self::$expiredRoutes);
97			}
98
99			public static function isExpired($path, $duration) {
100			$route=Router::getRoute($path, false);
101			if ($route !== false && \is_array($route)) {
102			return self::expired(self::getRouteKey($route), $duration);
103			}
104			return true;
105			}
106
107			public static function setExpired($routePath, $expired=true) {
108			$key=self::getRouteKey($routePath);
109			self::setKeyExpired($key, $expired);
110			}
111
112			public static function setRouteCache($routePath) {
113			$key=self::getRouteKey($routePath);
114			$response=Startup::runAsString($routePath);
115			return self::storeRouteResponse($key, $response);
116			}
117
118			public static function addAdminRoutes() {
119			self::addControllerCache("Ubiquity\controllers\Admin");
120			}
121
122			public static function getRoutes() {
123			$result=self::getControllerCache();
124			return $result;
125			}
126
127			public static function getControllerRoutes($controllerClass, $isRest=false) {
128			$result=[ ];
129			$ctrlCache=self::getControllerCache($isRest);
130			foreach ( $ctrlCache as $path => $routeAttributes ) {
131			if (isset($routeAttributes["controller"])) {
132			if ($routeAttributes["controller"] === $controllerClass) {
133			$result[$path]=$routeAttributes;
134			}
135			} else {
136			$firstValue=reset($routeAttributes);
137			if (isset($firstValue) && isset($firstValue["controller"])) {
138			if ($firstValue["controller"] === $controllerClass) {
139			$result[$path]=$routeAttributes;
140			}
141			}
142			}
143			}
144			return $result;
145			}
146
147			public static function addRoute($path, $controller, $action="index", $methods=null, $name="") {
148			$controllerCache=self::getControllerCache();
149			Router::addRouteToRoutes($controllerCache, $path, $controller, $action, $methods, $name);
150			self::$cache->store("controllers/routes", "return " . UArray::asPhpArray($controllerCache, "array") . ";", 'controllers');
151			}
152
153			public static function getControllersFiles(&$config, $silent=false) {
154			return self::_getFiles($config, "controllers", $silent);
155			}
156
157			public static function getControllers() {
158			$result=[ ];
159			$config=Startup::getConfig();
160			$files=self::getControllersFiles($config, true);
161			try {
162			$restCtrls=CacheManager::getRestCache();
163			} catch ( \Exception $e ) {
164			$restCtrls=[ ];
165			}
166			foreach ( $files as $file ) {
167			if (is_file($file)) {
168			$controllerClass=ClassUtils::getClassFullNameFromFile($file);
169			if (isset($restCtrls[$controllerClass]) === false) {
170			$r=new \ReflectionClass($controllerClass);
171			if($r->isSubclassOf("Ubiquity\\controllers\Controller") && !$r->isAbstract()){
172			$result[]=$controllerClass;
173			}
174			}
175			}
176			}
177			return $result;
178			}
179			}
180

phpMv / ubiquity

Push — master ( 0a01fe...765122 )

RouterCacheTrait::getControllers() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like