Merge pull request #105 from marcteyssier/2.0

Add a loop constructor arguments detector

Author: moufmouf

src/Mouf/MoufManager.php

@@ -2121,4 +2121,45 @@ public function setDelegateLookupContainer(ContainerInterface $delegateLookupCon
 		return $this;
 	}
 
+	/**
+	 * Check if there is no loop in constructor arguments
+	 * @throws MoufException
+	 */
+	public function checkConstructorLoop() {
+	    foreach ($this->declaredInstances as $instanceName => $descriptor) {
+	        $this->walkConstructorLoop($instanceName, []);
+	    }
+	}
+	
+	/**
+	 * This take a instance name and the path to access.
+	 * It throw an exception if a loop was detected
+	 * 
+	 * @param string $instanceName
+	 * @param array $path
+	 * @throws MoufException
+	 */
+	private function walkConstructorLoop($instanceName, array $path) {
+	    if(isset($path[$instanceName])) {
+	        $instances = array_keys($path);
+	        $instances = array_slice($instances, array_search($instanceName, $instances));
+	        throw new MoufException('A loop was detected on constructor arguments '.implode(' -> ', $instances).' -> '.$instanceName);
+	    }
+	    $path[$instanceName] = true;
+	    $descriptor = $this->declaredInstances[$instanceName];
+	    if(isset($descriptor['constructor'])) {
+    	    foreach ($descriptor['constructor'] as $constructorArg) {
+    	        if($constructorArg['parametertype'] == 'object') {
+    	            if(is_array($constructorArg['value'])) {
+    	                foreach ($constructorArg['value'] as $subInstanceName) {
+    	                    $this->walkConstructorLoop($subInstanceName, $path);
+    	                }
+    	            }
+    	            else {
+    	                $this->walkConstructorLoop($constructorArg['value'], $path);
+    	            }
+    	        }
+    	    }
+	    }
+	}
 }

src/Mouf/Validator/CheckConstructorLoopValidator.php

@@ -0,0 +1,32 @@
+<?php
+namespace Mouf\Validator;
+
+use Mouf\MoufManager;
+use Mouf\MoufInstanceDescriptor;
+use Mouf\MoufException;
+
+/**
+ * Check that there is no loop on constructor parameters
+ */
+class CheckConstructorLoopValidator implements MoufStaticValidatorInterface {
+
+	/**
+	 * Check all constructor arguments to detect a loop
+	 *
+	 * @return MoufValidatorResult
+	 */
+	public static function validateClass() {
+		$moufManager = MoufManager::getMoufManager();
+		
+		try {
+            $moufManager->checkConstructorLoop();
+			return new MoufValidatorResult(MoufValidatorResult::SUCCESS, "No loop detected in constructor arguments.");
+		}
+		catch(MoufException $e) {
+			return new MoufValidatorResult(MoufValidatorResult::ERROR, '<b>'.$e->getMessage().'</b><br /><br />
+			                 Please check yours instances to refactor your code and change your code architecture.<br />
+			                 The other ugly solution is to make a setter for one of this parameter to remove it from constructor argument');
+		}
+	}
+
+}