ControllerParser::asArray() - Code Metrics - Inspection of "Refactoring multiple OR with In(...)" - phpMv/ubiquity - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3845e2...5afe3b )

by Jean-Christophe

created 2018-06-24 19:06 UTC

ControllerParser::asArray() B

↳ Parent: ControllerParser

Complexity

Conditions	8
Paths	27

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	25
rs	8.4444
c	0
b	0
f	0
cc	8
nc	27
nop	0

<?php

namespace Ubiquity\cache\parser;

use Ubiquity\orm\parser\Reflexion;
use Ubiquity\utils\base\UString;
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();
			try{
			$annotsClass=Reflexion::getAnnotationClass($controllerClass, "@route");
			$restAnnotsClass=Reflexion::getAnnotationClass($controllerClass, "@rest");
			}catch (\Exception $e){

				
			}
			$this->rest=\sizeof($restAnnotsClass) > 0;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
			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) {

					try{
						$annots=Reflexion::getAnnotationsMethod($controllerClass, $method->name, "@route");
						if ($annots !== false) {
							foreach ( $annots as $annot ) {
								if (UString::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 && !UString::startswith($method->name, "_"))
									$this->routesMethods[$method->name]=[ "annotations" => $this->generateRouteAnnotationFromMethod($method),"method" => $method ];
							}
						}
					}catch(\Exception $e){}

				}
			}
		}
	}

	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 (!UString::endswith($prefix, "/"))
			$prefix=$prefix . "/";
		if ($path !== "" && UString::startswith($path, "/"))
			$path=\substr($path, 1);
		$path=$prefix . $path;
		if (!UString::endswith($path, "/") && !UString::endswith($path, '(.*?)') && !UString::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=UString::cleanAttribute(ClassUtils::getClassSimpleName($controllerClass) . "_" . $methodName);
		}
		$cache=$routeArray["cache"];
		$duration=$routeArray["duration"];
		$path=$pathParameters["path"];
		$parameters=$pathParameters["parameters"];
		$path=self::cleanpath($prefix, $path);
		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[$paramMatch])) {
						$requirement=$requirements[$paramMatch];
					}
					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\base\UString;
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		try{
25		$annotsClass=Reflexion::getAnnotationClass($controllerClass, "@route");
26		$restAnnotsClass=Reflexion::getAnnotationClass($controllerClass, "@rest");
27		}catch (\Exception $e){
		0 ignored issues – show Coding Style Comprehensibility introduced 2018-06-06 01:47 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
28
29		}
30		$this->rest=\sizeof($restAnnotsClass) > 0;
		0 ignored issues – show Bug introduced 2018-06-06 01:47 UTC by Report Bug Copy Issue Report The variable `$restAnnotsClass` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
31		if (\sizeof($annotsClass) > 0) {
32		$this->mainRouteClass=$annotsClass[0];
33		$inherited=$this->mainRouteClass->inherited;
34		$automated=$this->mainRouteClass->automated;
35		}
36		$methods=Reflexion::getMethods($instance, \ReflectionMethod::IS_PUBLIC);
37		foreach ( $methods as $method ) {
38		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...
39		try{
40		$annots=Reflexion::getAnnotationsMethod($controllerClass, $method->name, "@route");
41		if ($annots !== false) {
42		foreach ( $annots as $annot ) {
43		if (UString::isNull($annot->path)) {
44		$newAnnot=$this->generateRouteAnnotationFromMethod($method);
45		$annot->path=$newAnnot[0]->path;
46		}
47		}
48		$this->routesMethods[$method->name]=[ "annotations" => $annots,"method" => $method ];
49		} else {
50		if ($automated) {
51		if ($method->class !== 'Ubiquity\\controllers\\Controller' && \array_search($method->name, self::$excludeds) === false && !UString::startswith($method->name, "_"))
52		$this->routesMethods[$method->name]=[ "annotations" => $this->generateRouteAnnotationFromMethod($method),"method" => $method ];
53		}
54		}
55		}catch(\Exception $e){}
		0 ignored issues – show Coding Style Comprehensibility introduced 2018-06-06 01:47 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
56		}
57		}
58		}
59		}
60
61		private function generateRouteAnnotationFromMethod(\ReflectionMethod $method) {
62		$annot=new RouteAnnotation();
63		$annot->path=self::getPathFromMethod($method);
64		return [ $annot ];
65		}
66
67		private static function getPathFromMethod(\ReflectionMethod $method) {
68		$methodName=$method->getName();
69		if ($methodName === "index") {
70		$pathParts=[ "(index/)?" ];
71		} else {
72		$pathParts=[ $methodName ];
73		}
74		$parameters=$method->getParameters();
75		foreach ( $parameters as $parameter ) {
76		if ($parameter->isVariadic()) {
77		$pathParts[]='{...' . $parameter->getName() . '}';
78		return "/" . \implode("/", $pathParts);
79		}
80		if (!$parameter->isOptional()) {
81		$pathParts[]='{' . $parameter->getName() . '}';
82		} else {
83		$pathParts[\sizeof($pathParts) - 1].='{~' . $parameter->getName() . '}';
84		}
85		}
86		return "/" . \implode("/", $pathParts);
87		}
88
89		private static function cleanpath($prefix, $path="") {
90		if (!UString::endswith($prefix, "/"))
91		$prefix=$prefix . "/";
92		if ($path !== "" && UString::startswith($path, "/"))
93		$path=\substr($path, 1);
94		$path=$prefix . $path;
95		if (!UString::endswith($path, "/") && !UString::endswith($path, '(.*?)') && !UString::endswith($path, "(index/)?"))
96		$path=$path . "/";
97		return $path;
98		}
99
100		public function asArray() {
101		$result=[ ];
102		$prefix="";
103		$httpMethods=false;
104		if ($this->mainRouteClass) {
105		if (isset($this->mainRouteClass->path))
106		$prefix=$this->mainRouteClass->path;
107		if (isset($this->mainRouteClass->methods)) {
108		$httpMethods=$this->mainRouteClass->methods;
109		if ($httpMethods !== null) {
110		if (\is_string($httpMethods))
111		$httpMethods=[ $httpMethods ];
112		}
113		}
114		}
115		foreach ( $this->routesMethods as $method => $arrayAnnotsMethod ) {
116		$routeAnnotations=$arrayAnnotsMethod["annotations"];
117
118		foreach ( $routeAnnotations as $routeAnnotation ) {
119		$params=[ "path" => $routeAnnotation->path,"methods" => $routeAnnotation->methods,"name" => $routeAnnotation->name,"cache" => $routeAnnotation->cache,"duration" => $routeAnnotation->duration,"requirements" => $routeAnnotation->requirements ];
120		self::parseRouteArray($result, $this->controllerClass, $params, $arrayAnnotsMethod["method"], $method, $prefix, $httpMethods);
121		}
122		}
123		return $result;
124		}
125
126		public static function parseRouteArray(&$result, $controllerClass, $routeArray, \ReflectionMethod $method, $methodName, $prefix="", $httpMethods=NULL) {
127		if (!isset($routeArray["path"])) {
128		$routeArray["path"]=self::getPathFromMethod($method);
129		}
130		$pathParameters=self::addParamsPath($routeArray["path"], $method, $routeArray["requirements"]);
131		$name=$routeArray["name"];
132		if (!isset($name)) {
133		$name=UString::cleanAttribute(ClassUtils::getClassSimpleName($controllerClass) . "_" . $methodName);
134		}
135		$cache=$routeArray["cache"];
136		$duration=$routeArray["duration"];
137		$path=$pathParameters["path"];
138		$parameters=$pathParameters["parameters"];
139		$path=self::cleanpath($prefix, $path);
140		if (isset($routeArray["methods"]) && \is_array($routeArray["methods"])) {
141		self::createRouteMethod($result, $controllerClass, $path, $routeArray["methods"], $methodName, $parameters, $name, $cache, $duration);
142		} elseif (\is_array($httpMethods)) {
143		self::createRouteMethod($result, $controllerClass, $path, $httpMethods, $methodName, $parameters, $name, $cache, $duration);
144		} else {
145		$result[$path]=[ "controller" => $controllerClass,"action" => $methodName,"parameters" => $parameters,"name" => $name,"cache" => $cache,"duration" => $duration];
146		}
147		}
148
149		public static function addParamsPath($path, \ReflectionMethod $method, $requirements) {
150		$parameters=[ ];
151		$hasOptional=false;
152		preg_match_all('@\{(\.\.\.\|\~)?(.+?)\}@s', $path, $matches);
153		if (isset($matches[2]) && \sizeof($matches[2]) > 0) {
154		$path=\preg_quote($path);
155		$params=Reflexion::getMethodParameters($method);
156		$index=0;
157		foreach ( $matches[2] as $paramMatch ) {
158		$find=\array_search($paramMatch, $params);
159		if ($find !== false) {
160		$requirement='.+?';
161		if (isset($requirements[$paramMatch])) {
162		$requirement=$requirements[$paramMatch];
163		}
164		self::scanParam($parameters, $hasOptional, $matches, $index, $paramMatch, $find, $path, $requirement);
165		} else {
166		throw new \Exception("{$paramMatch} is not a parameter of the method " . $method->name);
167		}
168		$index++;
169		}
170		}
171		if ($hasOptional)
172		$path.="/(.*?)";
173		return [ "path" => $path,"parameters" => $parameters ];
174		}
175
176		private static function scanParam(&$parameters, &$hasOptional, $matches, $index, $paramMatch, $find, &$path, $requirement) {
177		if (isset($matches[1][$index])) {
178		if ($matches[1][$index] === "...") {
179		$parameters[]="*";
180		$path=\str_replace("\{\.\.\." . $paramMatch . "\}", "(.*?)", $path);
181		} elseif ($matches[1][$index] === "~") {
182		$parameters[]="~" . $find;
183		$path=\str_replace("\{~" . $paramMatch . "\}", "", $path);
184		$hasOptional=true;
185	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...
186		$parameters[]=$find;
187		$path=\str_replace("\{" . $paramMatch . "\}", "({$requirement})", $path);
188		}
189	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...
190		$parameters[]=$find;
191		$path=\str_replace("\{" . $paramMatch . "\}", "({$requirement})", $path);
192		}
193		}
194
195		private static function createRouteMethod(&$result, $controllerClass, $path, $httpMethods, $method, $parameters, $name, $cache, $duration) {
196		foreach ( $httpMethods as $httpMethod ) {
197		$result[$path][$httpMethod]=[ "controller" => $controllerClass,"action" => $method,"parameters" => $parameters,"name" => $name,"cache" => $cache,"duration" => $duration ];
198		}
199		}
200
201		public function isRest() {
202		return $this->rest;
203		}
204		}
205

phpMv / ubiquity

Push — master ( 3845e2...5afe3b )

ControllerParser::asArray() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like