- Check interfaces that extend other interfaces. If both list a metho…

…d, then the signature must be compatible. - Check interfaces "implemented" by an abstract base class. The base class doesn't need to actually implement, any non-abstract classes do.
BambooHR · Jul 10, 2024 · c3c5bff · c3c5bff
1 parent 67bdbc7
commit c3c5bff
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 69 deletions.
diff --git a/src/Checks/InterfaceCheck.php b/src/Checks/InterfaceCheck.php
@@ -18,7 +18,7 @@
 use PhpParser\Node;
 use PhpParser\Node\Stmt\Class_;
 use PhpParser\Node\Stmt\ClassLike;
-use PHPUnit\Util\Type;
+use PhpParser\Node\Stmt\Interface_;
 
 /**
  * Class InterfaceCheck
@@ -50,7 +50,7 @@ function __construct(SymbolTable $symbolTable, OutputInterface $doc) {
 	 * @return array
 	 */
 	public function getCheckNodeTypes() {
-		return [Class_::class];
+		return [Class_::class, Interface_::class];
 	}
 
 	/**
@@ -65,7 +65,7 @@ public function getCheckNodeTypes() {
 	 *
 	 * @return void
 	 */
-	protected function checkMethod($fileName, Class_ $class, Node\FunctionLike $astNode, MethodInterface $method, MethodInterface $parentMethod) {
+	protected function checkMethod($fileName, Class_|Interface_ $class, Node\FunctionLike $astNode, MethodInterface $method, MethodInterface $parentMethod) {
 
 		$visibility = $method->getAccessLevel();
 		$oldVisibility = $parentMethod->getAccessLevel();
@@ -96,7 +96,7 @@ protected function checkMethod($fileName, Class_ $class, Node\FunctionLike $astN
 						if (!$isContravariant) {
 							$childParamType = TypeComparer::typeToString($childParam->getType());
 							$parentParamType = TypeComparer::typeToString($parentParam->getType());
-							$this->emitErrorOnLine($fileName, $method->getStartingLine(), self::TYPE_SIGNATURE_TYPE, "Child method parameter " . $childParam->getName() . " type mismatch " . $className . "::" . $method->getName() . " : $parentParamType -> $childParamType");
+							$this->emitError($fileName, $astNode, self::TYPE_SIGNATURE_TYPE, "Child method parameter " . $childParam->getName() . " type mismatch " . $className . "::" . $method->getName() . " : $parentParamType -> $childParamType");
 						}
 					}
 					if ($childParam->getName() != $parentParam->getName()) {
@@ -163,34 +163,6 @@ private function assertParentChildReturnTypesMatch(
 		}
 	}
 
-	/**
-	 * implementsMethod
-	 *
-	 * @param Class_ $node            Instance of ClassAbstraction
-	 * @param string $interfaceMethod The interface
-	 *
-	 * @return ClassMethod|null
-	 */
-	protected function implementsMethod(Class_ $node, $interfaceMethod) {
-		$current = new AbstractedClass_($node);
-		while (true) {
-			// Is it directly in the class
-			$classMethod = $current->getMethod($interfaceMethod);
-			if ($classMethod) {
-				return $classMethod;
-			}
-
-			if ($current->getParentClassName()) {
-				$current = $this->symbolTable->getAbstractedClass($current->getParentClassName());
-				if (!$current) {
-					return null;
-				}
-			} else {
-				return null;
-			}
-		}
-	}
-
 	/**
 	 * run
 	 *
@@ -203,13 +175,16 @@ protected function implementsMethod(Class_ $node, $interfaceMethod) {
 	 */
 	public function run($fileName, Node $node, ClassLike $inside = null, Scope $scope = null) {
 		if ($node instanceof Class_) {
-			if ($node->implements) {
+			if ($node->implements || $node->extends) {
 				$this->processNodeImplements($fileName, $node);
 			}
 			if ($node->extends) {
 				$this->processNodeExtends($fileName, $node);
 			}
 		}
+		if ($node instanceof Interface_ && $node->extends) {
+			$this->processNodeImplements($fileName, $node);
+		}
 	}
 
 	/**
@@ -220,30 +195,19 @@ public function run($fileName, Node $node, ClassLike $inside = null, Scope $scop
 	 *
 	 * @return void
 	 */
-	private function processNodeImplements($fileName, Class_ $node) {
-		$arr = is_array($node->implements) ? $node->implements : [$node->implements];
-		foreach ($arr as $interface) {
-			$name = $interface->toString();
-			if ($name) {
-				$interface = $this->symbolTable->getAbstractedClass($name);
-				if (!$interface) {
-					$this->emitError($fileName, $node, ErrorConstants::TYPE_UNKNOWN_CLASS, $node->name . " implements unknown interface " . $name);
-				} else {
-					$this->processNodeImplementsNotAbstract($fileName, $node, $interface);
-				}
+	private function processNodeImplements(string $fileName, Class_|Interface_ $node):void {
+		$arr = Util::findAllInterfaces(strval($node->namespacedName), $this->symbolTable);
+		foreach ($arr as $name) {
+			$interface = $this->symbolTable->getAbstractedClass($name);
+			if (!$interface) {
+				$this->emitError($fileName, $node, ErrorConstants::TYPE_UNKNOWN_CLASS, $node->name . " implements unknown interface " . $name);
+			} else {
+				$this->processNodeImplementsInterface($fileName, $node, $interface);
 			}
 		}
 	}
 
-	/**
-	 * processNodeExtends
-	 *
-	 * @param string $fileName The file name
-	 * @param Node   $node     Instance of Node
-	 *
-	 * @return void
-	 */
-	private function processNodeExtends($fileName, Class_ $node) {
+	private function processNodeExtends(string $fileName, Class_ $node):void {
 		$class = new AbstractedClass_($node);
 		$parentClass = $this->symbolTable->getAbstractedClass($node->extends);
 		if (!$parentClass) {
@@ -262,22 +226,24 @@ private function processNodeExtends($fileName, Class_ $node) {
 		}
 	}
 
-	private function processNodeImplementsNotAbstract($fileName, Class_ $node, ClassInterface $interface) {
-		// Don't force abstract classes to implement all methods.
-		if (!$node->isAbstract()) {
-			foreach ($interface->getMethodNames() as $interfaceMethod) {
-				$classMethod = $this->implementsMethod($node, $interfaceMethod);
-				if (!$classMethod) {
-					if (!$node->isAbstract()) {
-						$this->emitError($fileName, $node, ErrorConstants::TYPE_UNIMPLEMENTED_METHOD, $node->name . " does not implement method " . $interfaceMethod);
-					}
-				} else {
-					foreach($node->stmts as $stmt) {
-						if ($stmt instanceof Node\Stmt\ClassMethod && strcasecmp($stmt->name, $interfaceMethod)==0) {
-							$this->checkMethod($fileName, $node, $stmt, $classMethod, $interface->getMethod($interfaceMethod));
-							break;
-						}
-					}
+	private function processNodeImplementsInterface(string $fileName, Class_|Interface_ $node, ClassInterface $interface):void {
+		$methods = $interface->getMethodNames();
+		foreach($methods as $methodName) {
+			$this->processInterfaceMethod($node, $methodName, $fileName, $interface);
+		}
+	}
+
+	public function processInterfaceMethod(Class_|Interface_ $node, string $interfaceMethod, string $fileName, ClassInterface $interface) : void {
+		$classMethod = Util::findAbstractedMethod($node->namespacedName, $interfaceMethod, $this->symbolTable);
+		if (!$classMethod) {
+			if ($node instanceof Node\Stmt\Class_ && !$node->isAbstract()) {
+				$this->emitError($fileName, $node, ErrorConstants::TYPE_UNIMPLEMENTED_METHOD, $node->name . " does not implement method " . $interfaceMethod);
+			}
+		} else {
+			foreach ($node->stmts as $stmt) {
+				if ($stmt instanceof Node\Stmt\ClassMethod && strcasecmp($stmt->name, $interfaceMethod) == 0) {
+					$this->checkMethod($fileName, $node, $stmt, $classMethod, $interface->getMethod($interfaceMethod));
+					break;
 				}
 			}
 		}

diff --git a/src/Util.php b/src/Util.php
@@ -225,6 +225,23 @@ static public function findAbstractedMethod($className, $name, SymbolTable $symb
 		return null;
 	}
 
+	static public function findAllInterfaces(string $className, SymbolTable $symbolTable):array {
+		$interfaces = [];
+		while ($className) {
+			$class = $symbolTable->getAbstractedClass($className);
+			if (!$class) {
+				return $interfaces;
+			}
+			$immediateList = $class->getInterfaceNames();
+			foreach($immediateList as $immediate ) {
+				$childInterfaces = static::findAllInterfaces($immediate, $symbolTable);
+				$interfaces = [ ...$childInterfaces, $immediate, ...$interfaces];
+			}
+			$className = $class->getParentClassName();
+		}
+ 		return array_unique($interfaces);
+	}
+
 	static function findAbstractedConstantExpr(string $className, string $constantName, SymbolTable $symbolTable) {
 		while ($className) {
 			$class = $symbolTable->getAbstractedClass($className);