Merge pull request #15 from sirbrillig/add/interface-support

Treat Interfaces as classes

Author: sirbrillig

ImportDetection/SniffHelpers.php

@@ -208,7 +208,7 @@ public function isSymbolADefinition(File $phpcsFile, Symbol $symbol): bool {
 	public function isTokenADefinition(array $token): bool {
 		// Note: this does not handle use or define
 		$type = $token['type'] ?? '';
-		$definitionTypes = ['T_CLASS', 'T_FUNCTION', 'T_CONST'];
+		$definitionTypes = ['T_CLASS', 'T_FUNCTION', 'T_CONST', 'T_INTERFACE'];
 		return in_array($type, $definitionTypes, true);
 	}
 

ImportDetection/Sniffs/Imports/RequireImportsSniff.php

@@ -190,13 +190,13 @@ private function isClassImported(File $phpcsFile, string $name): bool {
 	}
 
 	private function isClassDefined(File $phpcsFile, string $className): bool {
-		$classPtr = $phpcsFile->findNext([T_CLASS], 0);
+		$classPtr = $phpcsFile->findNext([T_CLASS, T_INTERFACE], 0);
 		while ($classPtr) {
 			$thisClassName = $phpcsFile->getDeclarationName($classPtr);
 			if ($className === $thisClassName) {
 				return true;
 			}
-			$classPtr = $phpcsFile->findNext([T_CLASS], $classPtr + 1);
+			$classPtr = $phpcsFile->findNext([T_CLASS, T_INTERFACE], $classPtr + 1);
 		}
 		return false;
 	}

tests/Sniffs/Imports/InterfaceFixture.php

@@ -0,0 +1,32 @@
+<?php
+
+// Declare the interface 'iTemplate'
+interface iTemplate
+{
+    public function setVariable($name, $var);
+    public function getHtml($template);
+}
+
+// Implement the interface
+// This will work
+class Template implements iTemplate
+{
+    private $vars = array();
+  
+    public function setVariable($name, $var)
+    {
+        $this->vars[$name] = $var;
+    }
+  
+    public function getHtml($template)
+    {
+        foreach($this->vars as $name => $value) {
+            $template = str_replace('{' . $name . '}', $value, $template);
+        }
+ 
+        return $template;
+    }
+}
+
+class BadClass implements BadTemplate {
+}

tests/Sniffs/Imports/RequireImportsSniffTest.php

@@ -100,6 +100,17 @@ public function testRequireImportsSniffCountsTraitUseAsUsage() {
 		$this->assertEquals($expectedLines, $lines);
 	}
 
+	public function testRequireImportsSniffWorksWithInterfaces() {
+		$fixtureFile = __DIR__ . '/InterfaceFixture.php';
+		$sniffFile = __DIR__ . '/../../../ImportDetection/Sniffs/Imports/RequireImportsSniff.php';
+		$helper = new SniffTestHelper();
+		$phpcsFile = $helper->prepareLocalFileForSniffs($sniffFile, $fixtureFile);
+		$phpcsFile->process();
+		$lines = $helper->getWarningLineNumbersFromFile($phpcsFile);
+		$expectedLines = [31];
+		$this->assertEquals($expectedLines, $lines);
+	}
+
 	public function testRequireImportsDoesNotBleedToMultipleFiles() {
 		$fixtureFile = __DIR__ . '/MultipleFilesFixtures';
 		$sniffFile = __DIR__ . '/../../../ImportDetection/Sniffs/Imports/RequireImportsSniff.php';