Use more precise list<type> instead of type[] where possible (#214)

spaze · Jul 26, 2023 · c7a80cc · c7a80cc
2 parents adf917d + 65fb9e8
commit c7a80cc
Show file tree

Hide file tree

Showing 33 changed files with 89 additions and 89 deletions.
diff --git a/phpstan.neon b/phpstan.neon
@@ -6,7 +6,7 @@ parameters:
 		CallParamConfig: 'array<int|string, int|bool|string|array{position:int, value?:int|bool|string, name?:string}>'
 		CallParamAnyValueConfig: 'array<int|string, int|array{position:int, value?:int|bool|string, name?:string}>'
 		CallParamFlagAnyValueConfig: 'array<int|string, int|array{position:int, value?:int, name?:string}>'
-		AllowDirectives: 'allowIn?:string[], allowExceptIn?:string[], disallowIn?:string[], allowInFunctions?:string[], allowInMethods?:string[], allowExceptInFunctions?:string[], allowExceptInMethods?:string[], disallowInFunctions?:string[], disallowInMethods?:string[], allowParamsInAllowed?:CallParamConfig, allowParamsInAllowedAnyValue?:CallParamAnyValueConfig, allowParamFlagsInAllowed?:CallParamFlagAnyValueConfig, allowParamsAnywhere?:CallParamConfig, allowParamsAnywhereAnyValue?:CallParamAnyValueConfig, allowParamFlagsAnywhere?:CallParamFlagAnyValueConfig, allowExceptParamsInAllowed?:CallParamConfig, allowExceptParamFlagsInAllowed?:CallParamFlagAnyValueConfig, disallowParamFlagsInAllowed?:CallParamFlagAnyValueConfig, disallowParamsInAllowed?:CallParamConfig, allowExceptParams?:CallParamConfig, disallowParams?:CallParamConfig, allowExceptParamFlags?:CallParamFlagAnyValueConfig, disallowParamFlags?:CallParamFlagAnyValueConfig, allowExceptCaseInsensitiveParams?:CallParamConfig, disallowCaseInsensitiveParams?:CallParamConfig'
+		AllowDirectives: 'allowIn?:list<string>, allowExceptIn?:list<string>, disallowIn?:list<string>, allowInFunctions?:list<string>, allowInMethods?:list<string>, allowExceptInFunctions?:list<string>, allowExceptInMethods?:list<string>, disallowInFunctions?:list<string>, disallowInMethods?:list<string>, allowParamsInAllowed?:CallParamConfig, allowParamsInAllowedAnyValue?:CallParamAnyValueConfig, allowParamFlagsInAllowed?:CallParamFlagAnyValueConfig, allowParamsAnywhere?:CallParamConfig, allowParamsAnywhereAnyValue?:CallParamAnyValueConfig, allowParamFlagsAnywhere?:CallParamFlagAnyValueConfig, allowExceptParamsInAllowed?:CallParamConfig, allowExceptParamFlagsInAllowed?:CallParamFlagAnyValueConfig, disallowParamFlagsInAllowed?:CallParamFlagAnyValueConfig, disallowParamsInAllowed?:CallParamConfig, allowExceptParams?:CallParamConfig, disallowParams?:CallParamConfig, allowExceptParamFlags?:CallParamFlagAnyValueConfig, disallowParamFlags?:CallParamFlagAnyValueConfig, allowExceptCaseInsensitiveParams?:CallParamConfig, disallowCaseInsensitiveParams?:CallParamConfig'
 		ForbiddenCallsConfig: 'array<array{function?:string|list<string>, method?:string|list<string>, exclude?:string|list<string>, definedIn?:string|list<string>, message?:string, %typeAliases.AllowDirectives%, errorIdentifier?:string, errorTip?:string}>'
 		DisallowedAttributesConfig: 'array<array{attribute:string|list<string>, exclude?:string|list<string>, message?:string, %typeAliases.AllowDirectives%, errorIdentifier?:string, errorTip?:string}>'
 		AllowDirectivesConfig: 'array{%typeAliases.AllowDirectives%}'

diff --git a/src/Allowed/AllowedConfig.php b/src/Allowed/AllowedConfig.php
@@ -8,16 +8,16 @@
 class AllowedConfig
 {
 
-	/** @var string[] */
+	/** @var list<string> */
 	private $allowIn;
 
-	/** @var string[] */
+	/** @var list<string> */
 	private $allowExceptIn;
 
-	/** @var string[] */
+	/** @var list<string> */
 	private $allowInCalls;
 
-	/** @var string[] */
+	/** @var list<string> */
 	private $allowExceptInCalls;
 
 	/** @var array<int|string, Param> */
@@ -34,10 +34,10 @@ class AllowedConfig
 
 
 	/**
-	 * @param string[] $allowIn
-	 * @param string[] $allowExceptIn
-	 * @param string[] $allowInCalls
-	 * @param string[] $allowExceptInCalls
+	 * @param list<string> $allowIn
+	 * @param list<string> $allowExceptIn
+	 * @param list<string> $allowInCalls
+	 * @param list<string> $allowExceptInCalls
 	 * @param array<int|string, Param> $allowParamsInAllowed
 	 * @param array<int|string, Param> $allowParamsAnywhere
 	 * @param array<int|string, Param> $allowExceptParamsInAllowed
@@ -65,7 +65,7 @@ public function __construct(
 
 
 	/**
-	 * @return string[]
+	 * @return list<string>
 	 */
 	public function getAllowIn(): array
 	{
@@ -74,7 +74,7 @@ public function getAllowIn(): array
 
 
 	/**
-	 * @return string[]
+	 * @return list<string>
 	 */
 	public function getAllowExceptIn(): array
 	{
@@ -83,7 +83,7 @@ public function getAllowExceptIn(): array
 
 
 	/**
-	 * @return string[]
+	 * @return list<string>
 	 */
 	public function getAllowInCalls(): array
 	{
@@ -92,7 +92,7 @@ public function getAllowInCalls(): array
 
 
 	/**
-	 * @return string[]
+	 * @return list<string>
 	 */
 	public function getAllowExceptInCalls(): array
 	{

diff --git a/src/Calls/EchoCalls.php b/src/Calls/EchoCalls.php
@@ -25,7 +25,7 @@ class EchoCalls implements Rule
 	/** @var DisallowedCallsRuleErrors */
 	private $disallowedCallsRuleErrors;
 
-	/** @var DisallowedCall[] */
+	/** @var list<DisallowedCall> */
 	private $disallowedCalls;
 
 
@@ -53,7 +53,7 @@ public function getNodeType(): string
 	/**
 	 * @param Echo_ $node
 	 * @param Scope $scope
-	 * @return RuleError[]
+	 * @return list<RuleError>
 	 * @throws ShouldNotHappenException
 	 */
 	public function processNode(Node $node, Scope $scope): array

diff --git a/src/Calls/EmptyCalls.php b/src/Calls/EmptyCalls.php
@@ -25,7 +25,7 @@ class EmptyCalls implements Rule
 	/** @var DisallowedCallsRuleErrors */
 	private $disallowedCallsRuleErrors;
 
-	/** @var DisallowedCall[] */
+	/** @var list<DisallowedCall> */
 	private $disallowedCalls;
 
 
@@ -53,7 +53,7 @@ public function getNodeType(): string
 	/**
 	 * @param Empty_ $node
 	 * @param Scope $scope
-	 * @return RuleError[]
+	 * @return list<RuleError>
 	 * @throws ShouldNotHappenException
 	 */
 	public function processNode(Node $node, Scope $scope): array

diff --git a/src/Calls/EvalCalls.php b/src/Calls/EvalCalls.php
@@ -25,7 +25,7 @@ class EvalCalls implements Rule
 	/** @var DisallowedCallsRuleErrors */
 	private $disallowedCallsRuleErrors;
 
-	/** @var DisallowedCall[] */
+	/** @var list<DisallowedCall> */
 	private $disallowedCalls;
 
 
@@ -53,7 +53,7 @@ public function getNodeType(): string
 	/**
 	 * @param Eval_ $node
 	 * @param Scope $scope
-	 * @return RuleError[]
+	 * @return list<RuleError>
 	 * @throws ShouldNotHappenException
 	 */
 	public function processNode(Node $node, Scope $scope): array

diff --git a/src/Calls/ExitDieCalls.php b/src/Calls/ExitDieCalls.php
@@ -25,7 +25,7 @@ class ExitDieCalls implements Rule
 	/** @var DisallowedCallsRuleErrors */
 	private $disallowedCallsRuleErrors;
 
-	/** @var DisallowedCall[] */
+	/** @var list<DisallowedCall> */
 	private $disallowedCalls;
 
 
@@ -53,7 +53,7 @@ public function getNodeType(): string
 	/**
 	 * @param Exit_ $node
 	 * @param Scope $scope
-	 * @return RuleError[]
+	 * @return list<RuleError>
 	 * @throws ShouldNotHappenException
 	 */
 	public function processNode(Node $node, Scope $scope): array

diff --git a/src/Calls/FunctionCalls.php b/src/Calls/FunctionCalls.php
@@ -27,7 +27,7 @@ class FunctionCalls implements Rule
 	/** @var DisallowedCallsRuleErrors */
 	private $disallowedCallsRuleErrors;
 
-	/** @var DisallowedCall[] */
+	/** @var list<DisallowedCall> */
 	private $disallowedCalls;
 
 	/** @var ReflectionProvider */
@@ -60,7 +60,7 @@ public function getNodeType(): string
 	/**
 	 * @param FuncCall $node
 	 * @param Scope $scope
-	 * @return RuleError[]
+	 * @return list<RuleError>
 	 * @throws ShouldNotHappenException
 	 */
 	public function processNode(Node $node, Scope $scope): array

diff --git a/src/Calls/MethodCalls.php b/src/Calls/MethodCalls.php
@@ -27,7 +27,7 @@ class MethodCalls implements Rule
 	/** @var DisallowedMethodRuleErrors */
 	private $disallowedMethodRuleErrors;
 
-	/** @var DisallowedCall[] */
+	/** @var list<DisallowedCall> */
 	private $disallowedCalls;
 
 
@@ -55,7 +55,7 @@ public function getNodeType(): string
 	/**
 	 * @param MethodCall $node
 	 * @param Scope $scope
-	 * @return RuleError[]
+	 * @return list<RuleError>
 	 * @throws ShouldNotHappenException
 	 */
 	public function processNode(Node $node, Scope $scope): array

diff --git a/src/Calls/NewCalls.php b/src/Calls/NewCalls.php
@@ -28,7 +28,7 @@ class NewCalls implements Rule
 	/** @var DisallowedCallsRuleErrors */
 	private $disallowedCallsRuleErrors;
 
-	/** @var DisallowedCall[] */
+	/** @var list<DisallowedCall> */
 	private $disallowedCalls;
 
 
@@ -56,7 +56,7 @@ public function getNodeType(): string
 	/**
 	 * @param New_ $node
 	 * @param Scope $scope
-	 * @return RuleError[]
+	 * @return list<RuleError>
 	 * @throws ShouldNotHappenException
 	 */
 	public function processNode(Node $node, Scope $scope): array

diff --git a/src/Calls/PrintCalls.php b/src/Calls/PrintCalls.php
@@ -25,7 +25,7 @@ class PrintCalls implements Rule
 	/** @var DisallowedCallsRuleErrors */
 	private $disallowedCallsRuleErrors;
 
-	/** @var DisallowedCall[] */
+	/** @var list<DisallowedCall> */
 	private $disallowedCalls;
 
 
@@ -53,7 +53,7 @@ public function getNodeType(): string
 	/**
 	 * @param Print_ $node
 	 * @param Scope $scope
-	 * @return RuleError[]
+	 * @return list<RuleError>
 	 * @throws ShouldNotHappenException
 	 */
 	public function processNode(Node $node, Scope $scope): array

diff --git a/src/Calls/ShellExecCalls.php b/src/Calls/ShellExecCalls.php
@@ -29,7 +29,7 @@ class ShellExecCalls implements Rule
 	/** @var DisallowedCallsRuleErrors */
 	private $disallowedCallsRuleErrors;
 
-	/** @var DisallowedCall[] */
+	/** @var list<DisallowedCall> */
 	private $disallowedCalls;
 
 
@@ -57,7 +57,7 @@ public function getNodeType(): string
 	/**
 	 * @param ShellExec $node
 	 * @param Scope $scope
-	 * @return RuleError[]
+	 * @return list<RuleError>
 	 * @throws ShouldNotHappenException
 	 */
 	public function processNode(Node $node, Scope $scope): array

diff --git a/src/Calls/StaticCalls.php b/src/Calls/StaticCalls.php
@@ -27,7 +27,7 @@ class StaticCalls implements Rule
 	/** @var DisallowedMethodRuleErrors */
 	private $disallowedMethodRuleErrors;
 
-	/** @var DisallowedCall[] */
+	/** @var list<DisallowedCall> */
 	private $disallowedCalls;
 
 
@@ -55,7 +55,7 @@ public function getNodeType(): string
 	/**
 	 * @param StaticCall $node
 	 * @param Scope $scope
-	 * @return RuleError[]
+	 * @return list<RuleError>
 	 * @throws ShouldNotHappenException
 	 */
 	public function processNode(Node $node, Scope $scope): array

diff --git a/src/Disallowed.php b/src/Disallowed.php
@@ -7,25 +7,25 @@ interface Disallowed
 {
 
 	/**
-	 * @return string[]
+	 * @return list<string>
 	 */
 	public function getAllowIn(): array;
 
 
 	/**
-	 * @return string[]
+	 * @return list<string>
 	 */
 	public function getAllowExceptIn(): array;
 
 
 	/**
-	 * @return string[]
+	 * @return list<string>
 	 */
 	public function getAllowInCalls(): array;
 
 
 	/**
-	 * @return string[]
+	 * @return list<string>
 	 */
 	public function getAllowExceptInCalls(): array;
 

diff --git a/src/DisallowedAttributeFactory.php b/src/DisallowedAttributeFactory.php
@@ -27,7 +27,7 @@ public function __construct(Allowed $allowed, Normalizer $normalizer)
 	/**
 	 * @param array $config
 	 * @phpstan-param DisallowedAttributesConfig $config
-	 * @return DisallowedAttribute[]
+	 * @return list<DisallowedAttribute>
 	 * @throws UnsupportedParamTypeInConfigException
 	 */
 	public function createFromConfig(array $config): array

diff --git a/src/DisallowedCallFactory.php b/src/DisallowedCallFactory.php
@@ -34,7 +34,7 @@ public function __construct(Formatter $formatter, Normalizer $normalizer, Allowe
 	 * @param array $config
 	 * @phpstan-param ForbiddenCallsConfig $config
 	 * @noinspection PhpUndefinedClassInspection ForbiddenCallsConfig is a type alias defined in PHPStan config
-	 * @return DisallowedCall[]
+	 * @return list<DisallowedCall>
 	 * @throws ShouldNotHappenException
 	 */
 	public function createFromConfig(array $config): array

diff --git a/src/DisallowedConstant.php b/src/DisallowedConstant.php
@@ -14,10 +14,10 @@ class DisallowedConstant implements Disallowed
 	/** @var string|null */
 	private $message;
 
-	/** @var string[] */
+	/** @var list<string> */
 	private $allowIn;
 
-	/** @var string[] */
+	/** @var list<string> */
 	private $allowExceptIn;
 
 	/** @var string|null */
@@ -30,8 +30,8 @@ class DisallowedConstant implements Disallowed
 	/**
 	 * @param string $constant
 	 * @param string|null $message
-	 * @param string[] $allowIn
-	 * @param string[] $allowExceptIn
+	 * @param list<string> $allowIn
+	 * @param list<string> $allowExceptIn
 	 * @param string|null $errorIdentifier
 	 * @param string|null $errorTip
 	 */

diff --git a/src/DisallowedConstantFactory.php b/src/DisallowedConstantFactory.php
@@ -20,8 +20,8 @@ public function __construct(Normalizer $normalizer)
 
 
 	/**
-	 * @param array<array{class?:string, constant?:string, message?:string, allowIn?:string[], allowExceptIn?:string[], disallowIn?:string[], errorIdentifier?:string, errorTip?:string}> $config
-	 * @return DisallowedConstant[]
+	 * @param array<array{class?:string, constant?:string, message?:string, allowIn?:list<string>, allowExceptIn?:list<string>, disallowIn?:list<string>, errorIdentifier?:string, errorTip?:string}> $config
+	 * @return list<DisallowedConstant>
 	 * @throws ShouldNotHappenException
 	 */
 	public function createFromConfig(array $config): array

diff --git a/src/DisallowedNamespace.php b/src/DisallowedNamespace.php
@@ -17,10 +17,10 @@ class DisallowedNamespace implements Disallowed
 	/** @var string|null */
 	private $message;
 
-	/** @var string[] */
+	/** @var list<string> */
 	private $allowIn;
 
-	/** @var string[] */
+	/** @var list<string> */
 	private $allowExceptIn;
 
 	/** @var string|null */
@@ -34,8 +34,8 @@ class DisallowedNamespace implements Disallowed
 	 * @param string $namespace
 	 * @param list<string> $excludes
 	 * @param string|null $message
-	 * @param string[] $allowIn
-	 * @param string[] $allowExceptIn
+	 * @param list<string> $allowIn
+	 * @param list<string> $allowExceptIn
 	 * @param string|null $errorIdentifier
 	 * @param string|null $errorTip
 	 */

diff --git a/src/DisallowedNamespaceFactory.php b/src/DisallowedNamespaceFactory.php
@@ -20,8 +20,8 @@ public function __construct(Normalizer $normalizer)
 
 
 	/**
-	 * @param array<array{namespace?:string, class?:string, exclude?:string|list<string>, message?:string, allowIn?:string[], allowExceptIn?:string[], disallowIn?:string[], errorIdentifier?:string, errorTip?:string}> $config
-	 * @return DisallowedNamespace[]
+	 * @param array<array{namespace?:string, class?:string, exclude?:string|list<string>, message?:string, allowIn?:list<string>, allowExceptIn?:list<string>, disallowIn?:list<string>, errorIdentifier?:string, errorTip?:string}> $config
+	 * @return list<DisallowedNamespace>
 	 */
 	public function createFromConfig(array $config): array
 	{

diff --git a/src/DisallowedSuperglobalFactory.php b/src/DisallowedSuperglobalFactory.php
@@ -25,8 +25,8 @@ class DisallowedSuperglobalFactory implements DisallowedVariableFactory
 
 
 	/**
-	 * @param array<array{superglobal?:string, message?:string, allowIn?:string[], allowExceptIn?:string[], disallowIn?:string[], errorIdentifier?:string, errorTip?:string}> $config
-	 * @return DisallowedVariable[]
+	 * @param array<array{superglobal?:string, message?:string, allowIn?:list<string>, allowExceptIn?:list<string>, disallowIn?:list<string>, errorIdentifier?:string, errorTip?:string}> $config
+	 * @return list<DisallowedVariable>
 	 * @throws ShouldNotHappenException
 	 */
 	public function getDisallowedVariables(array $config): array