Router::path() - Code Metrics - Inspection of "twig functions (path+url)" - phpMv/ubiquity - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c695c6...742385 )

by Jean-Christophe

created 2018-02-26 03:44 UTC

Router::path() A

↳ Parent: Router

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Ubiquity\controllers;

use Ubiquity\cache\CacheManager;
use Ubiquity\utils\RequestUtils;
use Ubiquity\cache\parser\ControllerParser;
use Ubiquity\utils\StrUtils;

/**
 * Router
 * @author jc
 * @version 1.0.0.2
 */
class Router {
	private static $routes;

	public static function slashPath($path){
		if(StrUtils::startswith($path,"/")===false)
			$path="/" . $path;
		if(!StrUtils::endswith($path, "/"))
			$path=$path."/";
		return $path;
	}

	public static function start() {
		self::$routes=CacheManager::getControllerCache();
	}

	public static function startRest() {
		self::$routes=CacheManager::getControllerCache(true);
	}

	public static function getRoute($path,$cachedResponse=true) {
		$path=self::slashPath($path);
		foreach ( self::$routes as $routePath => $routeDetails ) {
			if (preg_match("@^" . $routePath . "$@s", $path, $matches)) {
				if (!isset($routeDetails["controller"])) {
					$method=RequestUtils::getMethod();
					if (isset($routeDetails[$method]))
						return self::getRouteUrlParts([ "path" => $routePath,"details" => $routeDetails[$method] ], $matches, $routeDetails[$method]["cache"], $routeDetails[$method]["duration"],$cachedResponse);
				} else
					return self::getRouteUrlParts([ "path" => $routePath,"details" => $routeDetails ], $matches, $routeDetails["cache"], $routeDetails["duration"],$cachedResponse);
			}
		}
		return false;
	}

	public static function filterRoutes($path) {
		$path=self::slashPath($path);
		$result=[];
		foreach ( self::$routes as $routePath => $routeDetails ) {
			if (preg_match("@^" . $routePath . ".*?$@s", $path, $matches)) {
				$result[$routePath]=$routeDetails;
			}
		}
		return $result;
	}

	public static function getRouteInfo($path){
		$path=self::slashPath($path);
		foreach ( self::$routes as $routePath => $routeDetails ) {
			if (preg_match("@^" . $routePath . "$@s", $path, $matches)) {
				if (!isset($routeDetails["controller"])) {
						return \reset($routeDetails);
				} else
					return $routeDetails;
			}
		}
		return false;
	}

	public static function getAnnotations($controllerName,$actionName){
		$result=[];
		foreach ( self::$routes as $routePath => $routeDetails ) {
			if (!isset($routeDetails["controller"])) {
				$routeDetails=\reset($routeDetails);
			}
			if($routeDetails["controller"]===$controllerName && $routeDetails["action"]===$actionName)
				$result[$routePath]=$routeDetails;
		}
		return $result;
	}

	/**
	 * 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(!isset($routeDetails["name"])){
				foreach ($routeDetails as $methodRouteDetail){


				}
			}
			if (self::checkRouteName($routeDetails, $name)) {
				if(\sizeof($parameters)>0)
					$routePath=self::_getURL($routePath, $parameters);
				if ($absolute)
					return RequestUtils::getUrl($routePath);
				else
					return $routePath;
			}
		}
		return false;
	}

	public static function path($name,$parameters=[]){
		return self::getRouteByName($name,$parameters,false);
	}

	public static function url($name,$parameters=[]){
		return self::getRouteByName($name,$parameters,true);
	}
	protected static function _getURL($routePath,$params){
		return \preg_replace_callback('~\((.*?)\)~', function($matches) use (&$params) {

			return array_shift($params);
		}, $routePath);
	}

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

	public static function getRouteUrlParts($routeArray, $params, $cached=false, $duration=NULL,$cachedResponse=true) {
		$params=\array_slice($params, 1);
		$ctrl=str_replace("\\\\", "\\", $routeArray["details"]["controller"]);
		$result=[ $ctrl,$routeArray["details"]["action"] ];
		$paramsOrder=$routeArray["details"]["parameters"];
		$index=0;
		foreach ( $paramsOrder as $order ) {
			if($order==="*"){

				if(isset($params[$index]))
					$result=\array_merge($result,\array_diff(\explode("/", $params[$index]),[""]));
				break;
			}
			if(\substr($order, 0,1)==="~"){
				$order=\intval(\substr($order,1,1));
				if(isset($params[$order])){

					$result=\array_merge($result,\array_diff(\explode("/", $params[$order]),[""]));
					break;
				}
			}
			$result[]=self::cleanParam($params[$order]);
			unset($params[$order]);
			$index++;
		}
		if ($cached === true && $cachedResponse===true) {
			return CacheManager::getRouteCache($result, $duration);
		}
		return $result;
	}

	private static function cleanParam($param){
		if(StrUtils::endswith($param, "/"))
			return \substr($param, 0,-1);
		return $param;
	}

	/**
	 * Déclare une route comme étant expirée ou non
	 * @param string $routePath
	 * @param boolean $expired
	 */
	public static function setExpired($routePath, $expired=true) {
		CacheManager::setExpired($routePath, $expired);
	}

	/**
	 *
	 * @param string $path
	 * @param string $controller
	 * @param string $action
	 * @param array|null $methods
	 * @param string $name
	 * @param boolean $cache
	 * @param int $duration
	 */
	public static function addRoute($path, $controller, $action="index", $methods=null, $name="", $cache=false, $duration=null) {
		self::addRouteToRoutes(self::$routes, $path, $controller, $action, $methods, $name, $cache, $duration);
	}

	public static function addRouteToRoutes(&$routesArray, $path, $controller, $action="index", $methods=null, $name="", $cache=false, $duration=null) {
		$result=[ ];
		if(\class_exists($controller)){
			$method=new \ReflectionMethod($controller, $action);
			ControllerParser::parseRouteArray($result, $controller, [ "path" => $path,"methods" => $methods,"name" => $name,"cache" => $cache,"duration" => $duration ], $method, $action);
			foreach ( $result as $k => $v ) {
				$routesArray[$k]=$v;
			}
		}
	}
}


1		<?php
2
3		namespace Ubiquity\controllers;
4
5		use Ubiquity\cache\CacheManager;
6		use Ubiquity\utils\RequestUtils;
7		use Ubiquity\cache\parser\ControllerParser;
8		use Ubiquity\utils\StrUtils;
9
10		/**
11		* Router
12		* @author jc
13		* @version 1.0.0.2
14		*/
15		class Router {
16		private static $routes;
17
18		public static function slashPath($path){
19		if(StrUtils::startswith($path,"/")===false)
20		$path="/" . $path;
21		if(!StrUtils::endswith($path, "/"))
22		$path=$path."/";
23		return $path;
24		}
25
26		public static function start() {
27		self::$routes=CacheManager::getControllerCache();
28		}
29
30		public static function startRest() {
31		self::$routes=CacheManager::getControllerCache(true);
32		}
33
34		public static function getRoute($path,$cachedResponse=true) {
35		$path=self::slashPath($path);
36		foreach ( self::$routes as $routePath => $routeDetails ) {
37		if (preg_match("@^" . $routePath . "$@s", $path, $matches)) {
38		if (!isset($routeDetails["controller"])) {
39		$method=RequestUtils::getMethod();
40		if (isset($routeDetails[$method]))
41		return self::getRouteUrlParts([ "path" => $routePath,"details" => $routeDetails[$method] ], $matches, $routeDetails[$method]["cache"], $routeDetails[$method]["duration"],$cachedResponse);
42		} else
43		return self::getRouteUrlParts([ "path" => $routePath,"details" => $routeDetails ], $matches, $routeDetails["cache"], $routeDetails["duration"],$cachedResponse);
44		}
45		}
46		return false;
47		}
48
49		public static function filterRoutes($path) {
50		$path=self::slashPath($path);
51		$result=[];
52		foreach ( self::$routes as $routePath => $routeDetails ) {
53		if (preg_match("@^" . $routePath . ".*?$@s", $path, $matches)) {
54		$result[$routePath]=$routeDetails;
55		}
56		}
57		return $result;
58		}
59
60		public static function getRouteInfo($path){
61		$path=self::slashPath($path);
62		foreach ( self::$routes as $routePath => $routeDetails ) {
63		if (preg_match("@^" . $routePath . "$@s", $path, $matches)) {
64		if (!isset($routeDetails["controller"])) {
65		return \reset($routeDetails);
66		} else
67		return $routeDetails;
68		}
69		}
70		return false;
71		}
72
73		public static function getAnnotations($controllerName,$actionName){
74		$result=[];
75		foreach ( self::$routes as $routePath => $routeDetails ) {
76		if (!isset($routeDetails["controller"])) {
77		$routeDetails=\reset($routeDetails);
78		}
79		if($routeDetails["controller"]===$controllerName && $routeDetails["action"]===$actionName)
80		$result[$routePath]=$routeDetails;
81		}
82		return $result;
83		}
84
85		/**
86		* Returns the generated path from a route
87		* @param string $name name of the route
88		* @param array $parameters array of the route parameters. default : []
89		* @param boolean $absolute
90		*/
91		public static function getRouteByName($name, $parameters=[],$absolute=true) {
92		foreach ( self::$routes as $routePath => $routeDetails ) {
93		if(!isset($routeDetails["name"])){
94		foreach ($routeDetails as $methodRouteDetail){
		0 ignored issues – show Unused Code introduced 2018-02-26 03:46 UTC by Report Bug Copy Issue Report This `foreach` statement is empty and can be removed. This check looks for `foreach` loops that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete. Consider removing the loop. Loading history...
95
96		}
97		}
98		if (self::checkRouteName($routeDetails, $name)) {
99		if(\sizeof($parameters)>0)
100		$routePath=self::_getURL($routePath, $parameters);
101		if ($absolute)
102		return RequestUtils::getUrl($routePath);
103		else
104		return $routePath;
105		}
106		}
107		return false;
108		}
109
110		public static function path($name,$parameters=[]){
111		return self::getRouteByName($name,$parameters,false);
112		}
113
114		public static function url($name,$parameters=[]){
115		return self::getRouteByName($name,$parameters,true);
116		}
117		protected static function _getURL($routePath,$params){
118		return \preg_replace_callback('~\((.*?)\)~', function($matches) use (&$params) {
		0 ignored issues – show Unused Code introduced 2018-02-26 03:46 UTC by Report Bug Copy Issue Report The parameter `$matches` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
119		return array_shift($params);
120		}, $routePath);
121		}
122
123		protected static function checkRouteName($routeDetails,$name){
124		if(!isset($routeDetails["name"])){
125		foreach ($routeDetails as $methodRouteDetail){
126		if(isset($methodRouteDetail["name"]) && $methodRouteDetail==$name)
127		return true;
128		}
129		}
130		return isset($routeDetails["name"]) && $routeDetails["name"] == $name;
131		}
132
133		public static function getRouteUrlParts($routeArray, $params, $cached=false, $duration=NULL,$cachedResponse=true) {
134		$params=\array_slice($params, 1);
135		$ctrl=str_replace("\\\\", "\\", $routeArray["details"]["controller"]);
136		$result=[ $ctrl,$routeArray["details"]["action"] ];
137		$paramsOrder=$routeArray["details"]["parameters"];
138		$index=0;
139		foreach ( $paramsOrder as $order ) {
140	View Code Duplication	if($order==="*"){
		0 ignored issues – show Duplication introduced 2017-11-21 01:12 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
141		if(isset($params[$index]))
142		$result=\array_merge($result,\array_diff(\explode("/", $params[$index]),[""]));
143		break;
144		}
145		if(\substr($order, 0,1)==="~"){
146		$order=\intval(\substr($order,1,1));
147	View Code Duplication	if(isset($params[$order])){
		0 ignored issues – show Duplication introduced 2017-11-21 01:12 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
148		$result=\array_merge($result,\array_diff(\explode("/", $params[$order]),[""]));
149		break;
150		}
151		}
152		$result[]=self::cleanParam($params[$order]);
153		unset($params[$order]);
154		$index++;
155		}
156		if ($cached === true && $cachedResponse===true) {
157		return CacheManager::getRouteCache($result, $duration);
158		}
159		return $result;
160		}
161
162		private static function cleanParam($param){
163		if(StrUtils::endswith($param, "/"))
164		return \substr($param, 0,-1);
165		return $param;
166		}
167
168		/**
169		* Déclare une route comme étant expirée ou non
170		* @param string $routePath
171		* @param boolean $expired
172		*/
173		public static function setExpired($routePath, $expired=true) {
174		CacheManager::setExpired($routePath, $expired);
175		}
176
177		/**
178		*
179		* @param string $path
180		* @param string $controller
181		* @param string $action
182		* @param array\|null $methods
183		* @param string $name
184		* @param boolean $cache
185		* @param int $duration
186		*/
187		public static function addRoute($path, $controller, $action="index", $methods=null, $name="", $cache=false, $duration=null) {
188		self::addRouteToRoutes(self::$routes, $path, $controller, $action, $methods, $name, $cache, $duration);
189		}
190
191		public static function addRouteToRoutes(&$routesArray, $path, $controller, $action="index", $methods=null, $name="", $cache=false, $duration=null) {
192		$result=[ ];
193		if(\class_exists($controller)){
194		$method=new \ReflectionMethod($controller, $action);
195		ControllerParser::parseRouteArray($result, $controller, [ "path" => $path,"methods" => $methods,"name" => $name,"cache" => $cache,"duration" => $duration ], $method, $action);
196		foreach ( $result as $k => $v ) {
197		$routesArray[$k]=$v;
198		}
199		}
200		}
201		}
202

phpMv / ubiquity

Push — master ( c695c6...742385 )

Router::path() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like