ControllerParser::asArray() - Code Metrics - Inspection of "route requirements" - phpMv/ubiquity - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5b2faf...9fc245 )

by Jean-Christophe

created 2018-03-01 10:30 UTC

ControllerParser::asArray() C

↳ Parent: ControllerParser

Complexity

Conditions	8
Paths	27

Size

Total Lines	25
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	25
rs	5.3846
c	0
b	0
f	0
cc	8
eloc	18
nc	27
nop	0

<?php

namespace Ubiquity\cache\parser;

use Ubiquity\orm\parser\Reflexion;
use Ubiquity\utils\StrUtils;
use Ubiquity\annotations\router\RouteAnnotation;
use Ubiquity\cache\ClassUtils;

class ControllerParser {
	private $controllerClass;
	private $mainRouteClass;
	private $routesMethods=[ ];
	private $rest=false;
	private static $excludeds=[ "__construct","isValid","initialize","finalize","onInvalidControl","loadView","forward","redirectToRoute" ];

	public function parse($controllerClass) {
		$automated=false;
		$inherited=false;
		$this->controllerClass=$controllerClass;
		$reflect=new \ReflectionClass($controllerClass);
		if (!$reflect->isAbstract() && $reflect->isSubclassOf("Ubiquity\controllers\Controller")) {
			$instance=new $controllerClass();
			$annotsClass=Reflexion::getAnnotationClass($controllerClass, "@route");
			$restAnnotsClass=Reflexion::getAnnotationClass($controllerClass, "@rest");
			$this->rest=\sizeof($restAnnotsClass) > 0;
			if (\sizeof($annotsClass) > 0) {
				$this->mainRouteClass=$annotsClass[0];
				$inherited=$this->mainRouteClass->inherited;
				$automated=$this->mainRouteClass->automated;
			}
			$methods=Reflexion::getMethods($instance, \ReflectionMethod::IS_PUBLIC);
			foreach ( $methods as $method ) {
				if ($method->getDeclaringClass()->getName() === $controllerClass || $inherited) {

					$annots=Reflexion::getAnnotationsMethod($controllerClass, $method->name, "@route");
					if ($annots !== false) {
						foreach ( $annots as $annot ) {
							if (StrUtils::isNull($annot->path)) {
								$newAnnot=$this->generateRouteAnnotationFromMethod($method);
								$annot->path=$newAnnot[0]->path;
							}
						}
						$this->routesMethods[$method->name]=[ "annotations" => $annots,"method" => $method ];
					} else {
						if ($automated) {
							if ($method->class !== 'Ubiquity\\controllers\\Controller' && \array_search($method->name, self::$excludeds) === false && !StrUtils::startswith($method->name, "_"))
								$this->routesMethods[$method->name]=[ "annotations" => $this->generateRouteAnnotationFromMethod($method),"method" => $method ];
						}
					}
				}
			}
		}
	}

	private function generateRouteAnnotationFromMethod(\ReflectionMethod $method) {
		$annot=new RouteAnnotation();
		$annot->path=self::getPathFromMethod($method);
		return [ $annot ];
	}

	private static function getPathFromMethod(\ReflectionMethod $method) {
		$methodName=$method->getName();
		if ($methodName === "index") {
			$pathParts=[ "(index/)?" ];
		} else {
			$pathParts=[ $methodName ];
		}
		$parameters=$method->getParameters();
		foreach ( $parameters as $parameter ) {
			if ($parameter->isVariadic()) {
				$pathParts[]='{...' . $parameter->getName() . '}';
				return "/" . \implode("/", $pathParts);
			}
			if (!$parameter->isOptional()) {
				$pathParts[]='{' . $parameter->getName() . '}';
			} else {
				$pathParts[\sizeof($pathParts) - 1].='{~' . $parameter->getName() . '}';
			}
		}
		return "/" . \implode("/", $pathParts);
	}

	private static function cleanpath($prefix, $path="") {
		if (!StrUtils::endswith($prefix, "/"))
			$prefix=$prefix . "/";
		if ($path !== "" && StrUtils::startswith($path, "/"))
			$path=\substr($path, 1);
		$path=$prefix . $path;
		if (!StrUtils::endswith($path, "/") && !StrUtils::endswith($path, '(.*?)') && !StrUtils::endswith($path, "(index/)?"))
			$path=$path . "/";
		return $path;
	}

	public function asArray() {
		$result=[ ];
		$prefix="";
		$httpMethods=false;
		if ($this->mainRouteClass) {
			if (isset($this->mainRouteClass->path))
				$prefix=$this->mainRouteClass->path;
			if (isset($this->mainRouteClass->methods)) {
				$httpMethods=$this->mainRouteClass->methods;
				if ($httpMethods !== null) {
					if (\is_string($httpMethods))
						$httpMethods=[ $httpMethods ];
				}
			}
		}
		foreach ( $this->routesMethods as $method => $arrayAnnotsMethod ) {
			$routeAnnotations=$arrayAnnotsMethod["annotations"];

			foreach ( $routeAnnotations as $routeAnnotation ) {
				$params=[ "path" => $routeAnnotation->path,"methods" => $routeAnnotation->methods,"name" => $routeAnnotation->name,"cache" => $routeAnnotation->cache,"duration" => $routeAnnotation->duration,"requirements" => $routeAnnotation->requirements ];
				self::parseRouteArray($result, $this->controllerClass, $params, $arrayAnnotsMethod["method"], $method, $prefix, $httpMethods);
			}
		}
		return $result;
	}

	public static function parseRouteArray(&$result, $controllerClass, $routeArray, \ReflectionMethod $method, $methodName, $prefix="", $httpMethods=NULL) {
		if (!isset($routeArray["path"])) {
			$routeArray["path"]=self::getPathFromMethod($method);
		}
		$pathParameters=self::addParamsPath($routeArray["path"], $method, $routeArray["requirements"]);
		$name=$routeArray["name"];
		if (!isset($name)) {
			$name=StrUtils::cleanAttribute(ClassUtils::getClassSimpleName($controllerClass) . "_" . $methodName);
		}
		$cache=$routeArray["cache"];
		$duration=$routeArray["duration"];
		$path=$pathParameters["path"];
		$parameters=$pathParameters["parameters"];
		$path=self::cleanpath($prefix, $path);
		$controllerClass=ClassUtils::cleanClassname($controllerClass);
		if (isset($routeArray["methods"]) && \is_array($routeArray["methods"])) {
			self::createRouteMethod($result, $controllerClass, $path, $routeArray["methods"], $methodName, $parameters, $name, $cache, $duration);
		} elseif (\is_array($httpMethods)) {
			self::createRouteMethod($result, $controllerClass, $path, $httpMethods, $methodName, $parameters, $name, $cache, $duration);
		} else {
			$result[$path]=[ "controller" => $controllerClass,"action" => $methodName,"parameters" => $parameters,"name" => $name,"cache" => $cache,"duration" => $duration ];
		}
	}

	public static function addParamsPath($path, \ReflectionMethod $method, $requirements) {
		$parameters=[ ];
		$hasOptional=false;
		preg_match_all('@\{(\.\.\.|\~)?(.+?)\}@s', $path, $matches);
		if (isset($matches[2]) && \sizeof($matches[2]) > 0) {
			$path=\preg_quote($path);
			$params=Reflexion::getMethodParameters($method);
			$index=0;
			foreach ( $matches[2] as $paramMatch ) {
				$find=\array_search($paramMatch, $params);
				if ($find !== false) {
					$requirement='.+?';
					if (isset($requirements[$find])) {
						$requirement=$requirements[$find];
					}
					self::scanParam($parameters, $hasOptional, $matches, $index, $paramMatch, $find, $path, $requirement);
				} else {
					throw new \Exception("{$paramMatch} is not a parameter of the method " . $method->name);
				}
				$index++;
			}
		}
		if ($hasOptional)
			$path.="/(.*?)";
		return [ "path" => $path,"parameters" => $parameters ];
	}

	private static function scanParam(&$parameters, &$hasOptional, $matches, $index, $paramMatch, $find, &$path, $requirement) {
		if (isset($matches[1][$index])) {
			if ($matches[1][$index] === "...") {
				$parameters[]="*";
				$path=\str_replace("\{\.\.\." . $paramMatch . "\}", "(.*?)", $path);
			} elseif ($matches[1][$index] === "~") {
				$parameters[]="~" . $find;
				$path=\str_replace("\{~" . $paramMatch . "\}", "", $path);
				$hasOptional=true;
			} else {

				$parameters[]=$find;
				$path=\str_replace("\{" . $paramMatch . "\}", "({$requirement})", $path);
			}
		} else {

			$parameters[]=$find;
			$path=\str_replace("\{" . $paramMatch . "\}", "({$requirement})", $path);
		}
	}

	private static function createRouteMethod(&$result, $controllerClass, $path, $httpMethods, $method, $parameters, $name, $cache, $duration) {
		foreach ( $httpMethods as $httpMethod ) {
			$result[$path][$httpMethod]=[ "controller" => $controllerClass,"action" => $method,"parameters" => $parameters,"name" => $name,"cache" => $cache,"duration" => $duration ];
		}
	}

	public function isRest() {
		return $this->rest;
	}
}


1		<?php
2
3		namespace Ubiquity\cache\parser;
4
5		use Ubiquity\orm\parser\Reflexion;
6		use Ubiquity\utils\StrUtils;
7		use Ubiquity\annotations\router\RouteAnnotation;
8		use Ubiquity\cache\ClassUtils;
9
10		class ControllerParser {
11		private $controllerClass;
12		private $mainRouteClass;
13		private $routesMethods=[ ];
14		private $rest=false;
15		private static $excludeds=[ "__construct","isValid","initialize","finalize","onInvalidControl","loadView","forward","redirectToRoute" ];
16
17		public function parse($controllerClass) {
18		$automated=false;
19		$inherited=false;
20		$this->controllerClass=$controllerClass;
21		$reflect=new \ReflectionClass($controllerClass);
22		if (!$reflect->isAbstract() && $reflect->isSubclassOf("Ubiquity\controllers\Controller")) {
23		$instance=new $controllerClass();
24		$annotsClass=Reflexion::getAnnotationClass($controllerClass, "@route");
25		$restAnnotsClass=Reflexion::getAnnotationClass($controllerClass, "@rest");
26		$this->rest=\sizeof($restAnnotsClass) > 0;
27		if (\sizeof($annotsClass) > 0) {
28		$this->mainRouteClass=$annotsClass[0];
29		$inherited=$this->mainRouteClass->inherited;
30		$automated=$this->mainRouteClass->automated;
31		}
32		$methods=Reflexion::getMethods($instance, \ReflectionMethod::IS_PUBLIC);
33		foreach ( $methods as $method ) {
34		if ($method->getDeclaringClass()->getName() === $controllerClass \|\| $inherited) {
		1 ignored issue – show introduced 2018-01-15 02:19 UTC by Report Bug Copy Issue Report Consider using `$method->class`. There is an issue with `getName()` and APC-enabled PHP versions. Loading history...
35		$annots=Reflexion::getAnnotationsMethod($controllerClass, $method->name, "@route");
36		if ($annots !== false) {
37		foreach ( $annots as $annot ) {
38		if (StrUtils::isNull($annot->path)) {
39		$newAnnot=$this->generateRouteAnnotationFromMethod($method);
40		$annot->path=$newAnnot[0]->path;
41		}
42		}
43		$this->routesMethods[$method->name]=[ "annotations" => $annots,"method" => $method ];
44		} else {
45		if ($automated) {
46		if ($method->class !== 'Ubiquity\\controllers\\Controller' && \array_search($method->name, self::$excludeds) === false && !StrUtils::startswith($method->name, "_"))
47		$this->routesMethods[$method->name]=[ "annotations" => $this->generateRouteAnnotationFromMethod($method),"method" => $method ];
48		}
49		}
50		}
51		}
52		}
53		}
54
55		private function generateRouteAnnotationFromMethod(\ReflectionMethod $method) {
56		$annot=new RouteAnnotation();
57		$annot->path=self::getPathFromMethod($method);
58		return [ $annot ];
59		}
60
61		private static function getPathFromMethod(\ReflectionMethod $method) {
62		$methodName=$method->getName();
63		if ($methodName === "index") {
64		$pathParts=[ "(index/)?" ];
65		} else {
66		$pathParts=[ $methodName ];
67		}
68		$parameters=$method->getParameters();
69		foreach ( $parameters as $parameter ) {
70		if ($parameter->isVariadic()) {
71		$pathParts[]='{...' . $parameter->getName() . '}';
72		return "/" . \implode("/", $pathParts);
73		}
74		if (!$parameter->isOptional()) {
75		$pathParts[]='{' . $parameter->getName() . '}';
76		} else {
77		$pathParts[\sizeof($pathParts) - 1].='{~' . $parameter->getName() . '}';
78		}
79		}
80		return "/" . \implode("/", $pathParts);
81		}
82
83		private static function cleanpath($prefix, $path="") {
84		if (!StrUtils::endswith($prefix, "/"))
85		$prefix=$prefix . "/";
86		if ($path !== "" && StrUtils::startswith($path, "/"))
87		$path=\substr($path, 1);
88		$path=$prefix . $path;
89		if (!StrUtils::endswith($path, "/") && !StrUtils::endswith($path, '(.*?)') && !StrUtils::endswith($path, "(index/)?"))
90		$path=$path . "/";
91		return $path;
92		}
93
94		public function asArray() {
95		$result=[ ];
96		$prefix="";
97		$httpMethods=false;
98		if ($this->mainRouteClass) {
99		if (isset($this->mainRouteClass->path))
100		$prefix=$this->mainRouteClass->path;
101		if (isset($this->mainRouteClass->methods)) {
102		$httpMethods=$this->mainRouteClass->methods;
103		if ($httpMethods !== null) {
104		if (\is_string($httpMethods))
105		$httpMethods=[ $httpMethods ];
106		}
107		}
108		}
109		foreach ( $this->routesMethods as $method => $arrayAnnotsMethod ) {
110		$routeAnnotations=$arrayAnnotsMethod["annotations"];
111
112		foreach ( $routeAnnotations as $routeAnnotation ) {
113		$params=[ "path" => $routeAnnotation->path,"methods" => $routeAnnotation->methods,"name" => $routeAnnotation->name,"cache" => $routeAnnotation->cache,"duration" => $routeAnnotation->duration,"requirements" => $routeAnnotation->requirements ];
114		self::parseRouteArray($result, $this->controllerClass, $params, $arrayAnnotsMethod["method"], $method, $prefix, $httpMethods);
115		}
116		}
117		return $result;
118		}
119
120		public static function parseRouteArray(&$result, $controllerClass, $routeArray, \ReflectionMethod $method, $methodName, $prefix="", $httpMethods=NULL) {
121		if (!isset($routeArray["path"])) {
122		$routeArray["path"]=self::getPathFromMethod($method);
123		}
124		$pathParameters=self::addParamsPath($routeArray["path"], $method, $routeArray["requirements"]);
125		$name=$routeArray["name"];
126		if (!isset($name)) {
127		$name=StrUtils::cleanAttribute(ClassUtils::getClassSimpleName($controllerClass) . "_" . $methodName);
128		}
129		$cache=$routeArray["cache"];
130		$duration=$routeArray["duration"];
131		$path=$pathParameters["path"];
132		$parameters=$pathParameters["parameters"];
133		$path=self::cleanpath($prefix, $path);
134		$controllerClass=ClassUtils::cleanClassname($controllerClass);
135		if (isset($routeArray["methods"]) && \is_array($routeArray["methods"])) {
136		self::createRouteMethod($result, $controllerClass, $path, $routeArray["methods"], $methodName, $parameters, $name, $cache, $duration);
137		} elseif (\is_array($httpMethods)) {
138		self::createRouteMethod($result, $controllerClass, $path, $httpMethods, $methodName, $parameters, $name, $cache, $duration);
139		} else {
140		$result[$path]=[ "controller" => $controllerClass,"action" => $methodName,"parameters" => $parameters,"name" => $name,"cache" => $cache,"duration" => $duration ];
141		}
142		}
143
144		public static function addParamsPath($path, \ReflectionMethod $method, $requirements) {
145		$parameters=[ ];
146		$hasOptional=false;
147		preg_match_all('@\{(\.\.\.\|\~)?(.+?)\}@s', $path, $matches);
148		if (isset($matches[2]) && \sizeof($matches[2]) > 0) {
149		$path=\preg_quote($path);
150		$params=Reflexion::getMethodParameters($method);
151		$index=0;
152		foreach ( $matches[2] as $paramMatch ) {
153		$find=\array_search($paramMatch, $params);
154		if ($find !== false) {
155		$requirement='.+?';
156		if (isset($requirements[$find])) {
157		$requirement=$requirements[$find];
158		}
159		self::scanParam($parameters, $hasOptional, $matches, $index, $paramMatch, $find, $path, $requirement);
160		} else {
161		throw new \Exception("{$paramMatch} is not a parameter of the method " . $method->name);
162		}
163		$index++;
164		}
165		}
166		if ($hasOptional)
167		$path.="/(.*?)";
168		return [ "path" => $path,"parameters" => $parameters ];
169		}
170
171		private static function scanParam(&$parameters, &$hasOptional, $matches, $index, $paramMatch, $find, &$path, $requirement) {
172		if (isset($matches[1][$index])) {
173		if ($matches[1][$index] === "...") {
174		$parameters[]="*";
175		$path=\str_replace("\{\.\.\." . $paramMatch . "\}", "(.*?)", $path);
176		} elseif ($matches[1][$index] === "~") {
177		$parameters[]="~" . $find;
178		$path=\str_replace("\{~" . $paramMatch . "\}", "", $path);
179		$hasOptional=true;
180	View Code Duplication	} else {
		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...
181		$parameters[]=$find;
182		$path=\str_replace("\{" . $paramMatch . "\}", "({$requirement})", $path);
183		}
184	View Code Duplication	} else {
		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...
185		$parameters[]=$find;
186		$path=\str_replace("\{" . $paramMatch . "\}", "({$requirement})", $path);
187		}
188		}
189
190		private static function createRouteMethod(&$result, $controllerClass, $path, $httpMethods, $method, $parameters, $name, $cache, $duration) {
191		foreach ( $httpMethods as $httpMethod ) {
192		$result[$path][$httpMethod]=[ "controller" => $controllerClass,"action" => $method,"parameters" => $parameters,"name" => $name,"cache" => $cache,"duration" => $duration ];
193		}
194		}
195
196		public function isRest() {
197		return $this->rest;
198		}
199		}
200

phpMv / ubiquity

Push — master ( 5b2faf...9fc245 )

ControllerParser::asArray() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like