Full re-allow support for all items (#310)

The following items:
- constants
- enums
- superglobals
- control structures

can now be re-allowed in given
- methods or functions (`allowInMethods`, `allowInFunctions`)
- instances (`allowInInstanceOf`)
- classes with given attributes (`allowInClassWithAttributes`)
- methods and functions with attributes (`allowInMethodsWithAttributes`,
`allowInFunctionsWithAttributes`)
- classes with any method with given attributes
(`allowInClassWithMethodAttributes`)

Bringing the items listed above on par with the already fully supported items like namespaces, attributes, method and function calls.

Close #307

README.md

@@ -47,7 +47,7 @@ The extension supports versatile [custom rules](docs/custom-rules.md), too.
 
 ### Allow some previously disallowed calls or usages
 
-Let's say you have disallowed `foo()` with custom rules. But you want to re-allow it when used in your custom wrapper, or when the first parameter equals, or not, a specified value. The extension offers multiple ways of doing that:
+Let's say you have disallowed the `foo()` function (or any other supported items like constants or method calls etc.) with custom rules. But you want to re-allow it when used in your custom wrapper, or when the first parameter equals, or not, a specified value. The extension offers multiple ways of doing that:
 
 - [Ignore errors](docs/allow-ignore-errors.md) the PHPStan way
 - [Allow in paths](docs/allow-in-paths.md)

docs/allow-in-class-with-attributes.md

@@ -3,13 +3,6 @@
 It is possible to allow a previously disallowed item when done in a class with specified attributes.
 You can use the `allowInClassWithAttributes` configuration option.
 
-This is supported for the following items:
-- function calls
-- method calls
-- attribute usages
-- namespace usages
-- classname usages
-
 For example, if you'd have a configuration like this:
 
 ```neon

docs/allow-in-class-with-method-attributes.md

@@ -1,6 +1,6 @@
 ## Allow in class with given attributes on any method
 
-You can allow or disallow a function or a method, an attribute, a namespace or a classname in a class where any method, including the method the call is done in, but not the class itself, has the specified attribute.
+You can allow or disallow an item in a class where any method, including the method the call is done in, but not the class itself, has the specified attribute.
 This is done with `allowInClassWithMethodAttributes` and `allowExceptInClassWithMethodAttributes` (or `disallowInClassWithMethodAttributes` which is an alias). The method with the attribute can also be static, final or even abstract, and the method visibility doesn't matter.
 
 ```neon

docs/allow-in-instance-of.md

@@ -1,6 +1,6 @@
 ## Allow in classes, child classes, classes implementing an interface
 
-Use `allowInInstanceOf`, named after the PHP's `instanceof` operator, if you want to allow a function or a method call, an attribute, a classname, or a namespace in
+Use `allowInInstanceOf`, named after the PHP's `instanceof` operator, if you want to allow an item like function or a method call, an attribute, a classname, or a namespace etc. in
 - a class of given name
 - a class that inherits from a class of given name
 - a class that implements given interface

docs/allow-in-methods-with-attributes.md

@@ -1,6 +1,6 @@
 ## Allow in methods or functions with given attributes
 
-Similar to [allowing items in methods or functions by name](allow-in-methods.md), you can allow or disallow items like functions and method calls, attributes, namespace and classname usage in methods and functions with given attributes.
+Similar to [allowing items in methods or functions by name](allow-in-methods.md), you can allow or disallow items like functions and method calls, attributes, namespace and classname usage etc. in methods and functions with given attributes.
 
 You can use `allowInMethodsWithAttributes` (or the `allowInFunctionsWithAttributes` alias) for that:
 

docs/allow-in-methods.md

@@ -1,6 +1,6 @@
 ## Allow in methods or functions
 
-To allow a previously disallowed method or function only when called from a different method or function in any file, use `allowInFunctions` (or `allowInMethods` alias):
+To allow a previously disallowed item like method or function etc. only when called from a different method or function in any file, use `allowInFunctions` (or `allowInMethods` alias):
 
 ```neon
 parameters:

extension.neon

@@ -240,6 +240,27 @@ parametersSchema:
 			?allowIn: listOf(string()),
 			?allowExceptIn: listOf(string()),
 			?disallowIn: listOf(string()),
+			?allowInFunctions: listOf(string()),
+			?allowInMethods: listOf(string()),
+			?allowExceptInFunctions: listOf(string()),
+			?allowExceptInMethods: listOf(string()),
+			?disallowInFunctions: listOf(string()),
+			?disallowInMethods: listOf(string()),
+			?allowInInstanceOf: listOf(string()),
+			?allowExceptInInstanceOf: listOf(string()),
+			?disallowInInstanceOf: listOf(string()),
+			?allowInClassWithAttributes: listOf(string()),
+			?allowExceptInClassWithAttributes: listOf(string()),
+			?disallowInClassWithAttributes: listOf(string()),
+			?allowInFunctionsWithAttributes: listOf(string()),
+			?allowInMethodsWithAttributes: listOf(string()),
+			?allowExceptInFunctionsWithAttributes: listOf(string()),
+			?allowExceptInMethodsWithAttributes: listOf(string()),
+			?disallowInFunctionsWithAttributes: listOf(string()),
+			?disallowInMethodsWithAttributes: listOf(string()),
+			?allowInClassWithMethodAttributes: listOf(string()),
+			?allowExceptInClassWithMethodAttributes: listOf(string()),
+			?disallowInClassWithMethodAttributes: listOf(string()),
 			?errorIdentifier: string(),
 			?errorTip: string(),
 		])
@@ -251,6 +272,27 @@ parametersSchema:
 			?allowIn: listOf(string()),
 			?allowExceptIn: listOf(string()),
 			?disallowIn: listOf(string()),
+			?allowInFunctions: listOf(string()),
+			?allowInMethods: listOf(string()),
+			?allowExceptInFunctions: listOf(string()),
+			?allowExceptInMethods: listOf(string()),
+			?disallowInFunctions: listOf(string()),
+			?disallowInMethods: listOf(string()),
+			?allowInInstanceOf: listOf(string()),
+			?allowExceptInInstanceOf: listOf(string()),
+			?disallowInInstanceOf: listOf(string()),
+			?allowInClassWithAttributes: listOf(string()),
+			?allowExceptInClassWithAttributes: listOf(string()),
+			?disallowInClassWithAttributes: listOf(string()),
+			?allowInFunctionsWithAttributes: listOf(string()),
+			?allowInMethodsWithAttributes: listOf(string()),
+			?allowExceptInFunctionsWithAttributes: listOf(string()),
+			?allowExceptInMethodsWithAttributes: listOf(string()),
+			?disallowInFunctionsWithAttributes: listOf(string()),
+			?disallowInMethodsWithAttributes: listOf(string()),
+			?allowInClassWithMethodAttributes: listOf(string()),
+			?allowExceptInClassWithMethodAttributes: listOf(string()),
+			?disallowInClassWithMethodAttributes: listOf(string()),
 			?errorIdentifier: string(),
 			?errorTip: string(),
 		])
@@ -262,6 +304,27 @@ parametersSchema:
 			?allowIn: listOf(string()),
 			?allowExceptIn: list(string()),
 			?disallowIn: list(string()),
+			?allowInFunctions: listOf(string()),
+			?allowInMethods: listOf(string()),
+			?allowExceptInFunctions: listOf(string()),
+			?allowExceptInMethods: listOf(string()),
+			?disallowInFunctions: listOf(string()),
+			?disallowInMethods: listOf(string()),
+			?allowInInstanceOf: listOf(string()),
+			?allowExceptInInstanceOf: listOf(string()),
+			?disallowInInstanceOf: listOf(string()),
+			?allowInClassWithAttributes: listOf(string()),
+			?allowExceptInClassWithAttributes: listOf(string()),
+			?disallowInClassWithAttributes: listOf(string()),
+			?allowInFunctionsWithAttributes: listOf(string()),
+			?allowInMethodsWithAttributes: listOf(string()),
+			?allowExceptInFunctionsWithAttributes: listOf(string()),
+			?allowExceptInMethodsWithAttributes: listOf(string()),
+			?disallowInFunctionsWithAttributes: listOf(string()),
+			?disallowInMethodsWithAttributes: listOf(string()),
+			?allowInClassWithMethodAttributes: listOf(string()),
+			?allowExceptInClassWithMethodAttributes: listOf(string()),
+			?disallowInClassWithMethodAttributes: listOf(string()),
 			?errorIdentifier: string(),
 			?errorTip: string(),
 		])
@@ -325,6 +388,27 @@ parametersSchema:
 			?allowIn: listOf(string()),
 			?allowExceptIn: list(string()),
 			?disallowIn: list(string()),
+			?allowInFunctions: listOf(string()),
+			?allowInMethods: listOf(string()),
+			?allowExceptInFunctions: listOf(string()),
+			?allowExceptInMethods: listOf(string()),
+			?disallowInFunctions: listOf(string()),
+			?disallowInMethods: listOf(string()),
+			?allowInInstanceOf: listOf(string()),
+			?allowExceptInInstanceOf: listOf(string()),
+			?disallowInInstanceOf: listOf(string()),
+			?allowInClassWithAttributes: listOf(string()),
+			?allowExceptInClassWithAttributes: listOf(string()),
+			?disallowInClassWithAttributes: listOf(string()),
+			?allowInFunctionsWithAttributes: listOf(string()),
+			?allowInMethodsWithAttributes: listOf(string()),
+			?allowExceptInFunctionsWithAttributes: listOf(string()),
+			?allowExceptInMethodsWithAttributes: listOf(string()),
+			?disallowInFunctionsWithAttributes: listOf(string()),
+			?disallowInMethodsWithAttributes: listOf(string()),
+			?allowInClassWithMethodAttributes: listOf(string()),
+			?allowExceptInClassWithMethodAttributes: listOf(string()),
+			?disallowInClassWithMethodAttributes: listOf(string()),
 			?errorIdentifier: string(),
 			?errorTip: string(),
 		])

src/Allowed/AllowedPath.php

@@ -4,7 +4,6 @@
 namespace Spaze\PHPStan\Rules\Disallowed\Allowed;
 
 use PHPStan\Analyser\Scope;
-use Spaze\PHPStan\Rules\Disallowed\Disallowed;
 use Spaze\PHPStan\Rules\Disallowed\File\FilePath;
 
 class AllowedPath
@@ -25,23 +24,4 @@ public function matches(Scope $scope, string $allowedPath): bool
 		return $file !== null && $this->filePath->fnMatch($allowedPath, $file);
 	}
 
-
-	public function isAllowedPath(Scope $scope, Disallowed $disallowed): bool
-	{
-		foreach ($disallowed->getAllowIn() as $allowedPath) {
-			if ($this->matches($scope, $allowedPath)) {
-				return true;
-			}
-		}
-		if ($disallowed->getAllowExceptIn()) {
-			foreach ($disallowed->getAllowExceptIn() as $allowedExceptPath) {
-				if ($this->matches($scope, $allowedExceptPath)) {
-					return false;
-				}
-			}
-			return true;
-		}
-		return false;
-	}
-
 }

src/ControlStructures/BreakControlStructure.php

@@ -53,7 +53,7 @@ public function getNodeType(): string
 	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
-		return $this->disallowedControlStructureRuleErrors->get($scope, 'break', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_BREAK);
+		return $this->disallowedControlStructureRuleErrors->get($node, $scope, 'break', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_BREAK);
 	}
 
 }

src/ControlStructures/ContinueControlStructure.php

@@ -53,7 +53,7 @@ public function getNodeType(): string
 	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
-		return $this->disallowedControlStructureRuleErrors->get($scope, 'continue', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_CONTINUE);
+		return $this->disallowedControlStructureRuleErrors->get($node, $scope, 'continue', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_CONTINUE);
 	}
 
 }

src/ControlStructures/DeclareControlStructure.php

@@ -53,7 +53,7 @@ public function getNodeType(): string
 	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
-		return $this->disallowedControlStructureRuleErrors->get($scope, 'declare', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_DECLARE);
+		return $this->disallowedControlStructureRuleErrors->get($node, $scope, 'declare', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_DECLARE);
 	}
 
 }

src/ControlStructures/DoWhileControlStructure.php

@@ -53,7 +53,7 @@ public function getNodeType(): string
 	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
-		return $this->disallowedControlStructureRuleErrors->get($scope, 'do-while', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_DO_WHILE);
+		return $this->disallowedControlStructureRuleErrors->get($node, $scope, 'do-while', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_DO_WHILE);
 	}
 
 }

src/ControlStructures/ElseControlStructure.php

@@ -53,7 +53,7 @@ public function getNodeType(): string
 	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
-		return $this->disallowedControlStructureRuleErrors->get($scope, 'else', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_ELSE);
+		return $this->disallowedControlStructureRuleErrors->get($node, $scope, 'else', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_ELSE);
 	}
 
 }

src/ControlStructures/ElseIfControlStructure.php

@@ -54,7 +54,7 @@ public function getNodeType(): string
 	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
-		return $this->disallowedControlStructureRuleErrors->get($scope, 'elseif', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_ELSE_IF);
+		return $this->disallowedControlStructureRuleErrors->get($node, $scope, 'elseif', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_ELSE_IF);
 	}
 
 }

src/ControlStructures/ForControlStructure.php

@@ -53,7 +53,7 @@ public function getNodeType(): string
 	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
-		return $this->disallowedControlStructureRuleErrors->get($scope, 'for', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_FOR);
+		return $this->disallowedControlStructureRuleErrors->get($node, $scope, 'for', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_FOR);
 	}
 
 }

src/ControlStructures/ForeachControlStructure.php

@@ -53,7 +53,7 @@ public function getNodeType(): string
 	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
-		return $this->disallowedControlStructureRuleErrors->get($scope, 'foreach', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_FOREACH);
+		return $this->disallowedControlStructureRuleErrors->get($node, $scope, 'foreach', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_FOREACH);
 	}
 
 }

src/ControlStructures/GotoControlStructure.php

@@ -53,7 +53,7 @@ public function getNodeType(): string
 	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
-		return $this->disallowedControlStructureRuleErrors->get($scope, 'goto', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_GOTO);
+		return $this->disallowedControlStructureRuleErrors->get($node, $scope, 'goto', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_GOTO);
 	}
 
 }

src/ControlStructures/IfControlStructure.php

@@ -53,7 +53,7 @@ public function getNodeType(): string
 	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
-		return $this->disallowedControlStructureRuleErrors->get($scope, 'if', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_IF);
+		return $this->disallowedControlStructureRuleErrors->get($node, $scope, 'if', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_IF);
 	}
 
 }

src/ControlStructures/MatchControlStructure.php

@@ -53,7 +53,7 @@ public function getNodeType(): string
 	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
-		return $this->disallowedControlStructureRuleErrors->get($scope, 'match', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_MATCH);
+		return $this->disallowedControlStructureRuleErrors->get($node, $scope, 'match', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_MATCH);
 	}
 
 }

src/ControlStructures/RequireIncludeControlStructure.php

@@ -75,7 +75,7 @@ public function processNode(Node $node, Scope $scope): array
 		if ($type === null) {
 			return [];
 		}
-		return $this->disallowedControlStructureRuleErrors->get($scope, $type, $this->disallowedControlStructures, $identifier);
+		return $this->disallowedControlStructureRuleErrors->get($node, $scope, $type, $this->disallowedControlStructures, $identifier);
 	}
 
 }

src/ControlStructures/ReturnControlStructure.php

@@ -53,7 +53,7 @@ public function getNodeType(): string
 	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
-		return $this->disallowedControlStructureRuleErrors->get($scope, 'return', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_RETURN);
+		return $this->disallowedControlStructureRuleErrors->get($node, $scope, 'return', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_RETURN);
 	}
 
 }

src/ControlStructures/SwitchControlStructure.php

@@ -53,7 +53,7 @@ public function getNodeType(): string
 	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
-		return $this->disallowedControlStructureRuleErrors->get($scope, 'switch', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_SWITCH);
+		return $this->disallowedControlStructureRuleErrors->get($node, $scope, 'switch', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_SWITCH);
 	}
 
 }

src/ControlStructures/WhileControlStructure.php

@@ -53,7 +53,7 @@ public function getNodeType(): string
 	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
-		return $this->disallowedControlStructureRuleErrors->get($scope, 'while', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_WHILE);
+		return $this->disallowedControlStructureRuleErrors->get($node, $scope, 'while', $this->disallowedControlStructures, ErrorIdentifiers::DISALLOWED_WHILE);
 	}
 
 }