ControllerParser::isRest() - Code Metrics - Inspection of "Rest service (admin)" - phpMv/ubiquity - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0feaa6...f4afa6 )

by Jean-Christophe

created 2017-11-24 01:30 UTC

ControllerParser::isRest() A

↳ Parent: ControllerParser

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace micro\cache\parser;

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

class ControllerParser {
	private $controllerClass;
	private $mainRouteClass;
	private $routesMethods=[ ];
	private $rest=false;

	private static $excludeds=["__construct","isValid","initialize","finalize","onInvalidControl","loadView","forward"];


	public function parse($controllerClass) {
		$this->controllerClass=$controllerClass;
		$reflect=new \ReflectionClass($controllerClass);
		if (!$reflect->isAbstract() && $reflect->isSubclassOf("micro\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];
			$methods=Reflexion::getMethods($instance, \ReflectionMethod::IS_PUBLIC);
			foreach ( $methods as $method ) {
				$annots=Reflexion::getAnnotationsMethod($controllerClass, $method->name, "@route");
				if ($annots !== false){
					foreach ($annots as $annot){
						if(StrUtils::isNull($annot->path)){
							$annot->path="/".$method->getName();

						}
					}
					$this->routesMethods[$method->name]=[ "annotations" => $annots,"method" => $method ];
				}else{
					if($this->rest && isset($this->mainRouteClass)){
						if($method->class!=='micro\\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 ];
				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);
		$name=$routeArray["name"];
		$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) {
		$parameters=[ ];
		$hasOptionnal=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) {
					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);
							$hasOptionnal=true;
						}else{

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

						$parameters[]=$find;
						$path=\str_replace("\{" . $paramMatch . "\}", "(.+?)", $path);
					}
				} else {
					throw new \Exception("{$paramMatch} is not a parameter of the method " . $method->name);
				}
				$index++;
			}
		}
		if($hasOptionnal)
			$path.="/(.*?)";
		return [ "path" => $path,"parameters" => $parameters ];
	}

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

phpMv / ubiquity

Push — master ( 0feaa6...f4afa6 )

ControllerParser::isRest() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like