Ubiquity\controllers\Router

Complexity

Total Complexity

53

Size/Duplication

Total Lines	187
Duplicated Lines	4.81 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	slashPath()	0	7	3
A	start()	0	3	1
A	startRest()	0	3	1
B	getRoute()	0	14	5
A	filterRoutes()	0	10	3
A	getRouteInfo()	0	12	4
B	getAnnotations()	0	11	5
B	getRouteByName()	0	18	7
A	path()	0	3	1
A	url()	0	3	1
A	_getURL()	0	5	1
B	checkRouteName()	0	9	6
C	getRouteUrlParts()	9	28	8
A	cleanParam()	0	5	2
A	setExpired()	0	3	1
A	addRoute()	0	3	1
A	addRouteToRoutes()	0	10	3

<?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){

This foreach statement is empty and can be removed.

				}
			}
			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) {

The parameter $matches is not used and could be removed.

			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==="*"){

This code seems to be duplicated across your project.

				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])){

This code seems to be duplicated across your project.

					$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;
			}
		}
	}
}