Internal classes made final, @api classes made @final

`@api` classes will become `final` in PHPStan 2.0 PHPStan\Type\Type interface implementations are excluded from these changes If these changes impact your project, please open a GitHub Discussion so we can have a conversation about your use case and solve it properly.
phpstan · Jul 25, 2024 · 4010b73 · 4010b73
1 parent 67193b6
commit 4010b73
Show file tree

Hide file tree

Showing 994 changed files with 1,313 additions and 1,027 deletions.
diff --git a/bin/generate-rule-error-classes.php b/bin/generate-rule-error-classes.php
@@ -14,7 +14,7 @@
 /**
  * @internal Use PHPStan\Rules\RuleErrorBuilder instead.
  */
-class RuleError%s implements %s
+final class RuleError%s implements %s
 {
 
 	%s

diff --git a/build/enum-adapter-errors.neon b/build/enum-adapter-errors.neon
@@ -144,8 +144,3 @@ parameters:
 			message: "#^Method PHPStan\\\\Reflection\\\\Php\\\\BuiltinMethodReflection\\:\\:getDeclaringClass\\(\\) has invalid return type PHPStan\\\\BetterReflection\\\\Reflection\\\\Adapter\\\\ReflectionEnum\\.$#"
 			count: 1
 			path: ../src/Reflection/Php/BuiltinMethodReflection.php
-
-		-
-			message: "#^Method PHPStan\\\\Reflection\\\\Php\\\\NativeBuiltinMethodReflection\\:\\:getDeclaringClass\\(\\) has invalid return type PHPStan\\\\BetterReflection\\\\Reflection\\\\Adapter\\\\ReflectionEnum\\.$#"
-			count: 1
-			path: ../src/Reflection/Php/NativeBuiltinMethodReflection.php
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -212,31 +212,6 @@ parameters:
 			count: 1
 			path: src/PhpDoc/StubValidator.php
 
-		-
-			message: "#^Return type \\(PHPStan\\\\PhpDoc\\\\Tag\\\\ParamOutTag\\) of method PHPStan\\\\PhpDoc\\\\Tag\\\\ParamOutTag\\:\\:withType\\(\\) should be covariant with return type \\(static\\(PHPStan\\\\PhpDoc\\\\Tag\\\\TypedTag\\)\\) of method PHPStan\\\\PhpDoc\\\\Tag\\\\TypedTag\\:\\:withType\\(\\)$#"
-			count: 1
-			path: src/PhpDoc/Tag/ParamOutTag.php
-
-		-
-			message: "#^Return type \\(PHPStan\\\\PhpDoc\\\\Tag\\\\ParamTag\\) of method PHPStan\\\\PhpDoc\\\\Tag\\\\ParamTag\\:\\:withType\\(\\) should be covariant with return type \\(static\\(PHPStan\\\\PhpDoc\\\\Tag\\\\TypedTag\\)\\) of method PHPStan\\\\PhpDoc\\\\Tag\\\\TypedTag\\:\\:withType\\(\\)$#"
-			count: 1
-			path: src/PhpDoc/Tag/ParamTag.php
-
-		-
-			message: "#^Return type \\(PHPStan\\\\PhpDoc\\\\Tag\\\\ReturnTag\\) of method PHPStan\\\\PhpDoc\\\\Tag\\\\ReturnTag\\:\\:withType\\(\\) should be covariant with return type \\(static\\(PHPStan\\\\PhpDoc\\\\Tag\\\\TypedTag\\)\\) of method PHPStan\\\\PhpDoc\\\\Tag\\\\TypedTag\\:\\:withType\\(\\)$#"
-			count: 1
-			path: src/PhpDoc/Tag/ReturnTag.php
-
-		-
-			message: "#^Return type \\(PHPStan\\\\PhpDoc\\\\Tag\\\\SelfOutTypeTag\\) of method PHPStan\\\\PhpDoc\\\\Tag\\\\SelfOutTypeTag\\:\\:withType\\(\\) should be covariant with return type \\(static\\(PHPStan\\\\PhpDoc\\\\Tag\\\\TypedTag\\)\\) of method PHPStan\\\\PhpDoc\\\\Tag\\\\TypedTag\\:\\:withType\\(\\)$#"
-			count: 1
-			path: src/PhpDoc/Tag/SelfOutTypeTag.php
-
-		-
-			message: "#^Return type \\(PHPStan\\\\PhpDoc\\\\Tag\\\\VarTag\\) of method PHPStan\\\\PhpDoc\\\\Tag\\\\VarTag\\:\\:withType\\(\\) should be covariant with return type \\(static\\(PHPStan\\\\PhpDoc\\\\Tag\\\\TypedTag\\)\\) of method PHPStan\\\\PhpDoc\\\\Tag\\\\TypedTag\\:\\:withType\\(\\)$#"
-			count: 1
-			path: src/PhpDoc/Tag/VarTag.php
-
 		-
 			message: "#^Doing instanceof PHPStan\\\\Type\\\\ArrayType is error\\-prone and deprecated\\. Use Type\\:\\:isArray\\(\\) or Type\\:\\:getArrays\\(\\) instead\\.$#"
 			count: 1

diff --git a/src/Analyser/Analyser.php b/src/Analyser/Analyser.php
@@ -12,7 +12,7 @@
 use function count;
 use function memory_get_peak_usage;
 
-class Analyser
+final class Analyser
 {
 
 	public function __construct(

diff --git a/src/Analyser/AnalyserResult.php b/src/Analyser/AnalyserResult.php
@@ -9,7 +9,7 @@
 /**
  * @phpstan-import-type LinesToIgnore from FileAnalyserResult
  */
-class AnalyserResult
+final class AnalyserResult
 {
 
 	/** @var list<Error>|null */

diff --git a/src/Analyser/AnalyserResultFinalizer.php b/src/Analyser/AnalyserResultFinalizer.php
@@ -14,7 +14,7 @@
 use function get_class;
 use function sprintf;
 
-class AnalyserResultFinalizer
+final class AnalyserResultFinalizer
 {
 
 	public function __construct(

diff --git a/src/Analyser/ConditionalExpressionHolder.php b/src/Analyser/ConditionalExpressionHolder.php
@@ -8,7 +8,7 @@
 use function implode;
 use function sprintf;
 
-class ConditionalExpressionHolder
+final class ConditionalExpressionHolder
 {
 
 	/**

diff --git a/src/Analyser/ConstantResolver.php b/src/Analyser/ConstantResolver.php
@@ -25,7 +25,7 @@
 use const NAN;
 use const PHP_INT_SIZE;
 
-class ConstantResolver
+final class ConstantResolver
 {
 
 	/** @var array<string, true> */

diff --git a/src/Analyser/ConstantResolverFactory.php b/src/Analyser/ConstantResolverFactory.php
@@ -5,7 +5,7 @@
 use PHPStan\DependencyInjection\Container;
 use PHPStan\Reflection\ReflectionProvider\ReflectionProviderProvider;
 
-class ConstantResolverFactory
+final class ConstantResolverFactory
 {
 
 	public function __construct(

diff --git a/src/Analyser/DirectInternalScopeFactory.php b/src/Analyser/DirectInternalScopeFactory.php
@@ -17,7 +17,7 @@
 use PHPStan\ShouldNotHappenException;
 use function is_a;
 
-class DirectInternalScopeFactory implements InternalScopeFactory
+final class DirectInternalScopeFactory implements InternalScopeFactory
 {
 
 	/**

diff --git a/src/Analyser/EndStatementResult.php b/src/Analyser/EndStatementResult.php
@@ -4,7 +4,7 @@
 
 use PhpParser\Node\Stmt;
 
-class EndStatementResult
+final class EndStatementResult
 {
 
 	public function __construct(

diff --git a/src/Analyser/EnsuredNonNullabilityResult.php b/src/Analyser/EnsuredNonNullabilityResult.php
@@ -2,7 +2,7 @@
 
 namespace PHPStan\Analyser;
 
-class EnsuredNonNullabilityResult
+final class EnsuredNonNullabilityResult
 {
 
 	/**

diff --git a/src/Analyser/EnsuredNonNullabilityResultExpression.php b/src/Analyser/EnsuredNonNullabilityResultExpression.php
@@ -6,7 +6,7 @@
 use PHPStan\TrinaryLogic;
 use PHPStan\Type\Type;
 
-class EnsuredNonNullabilityResultExpression
+final class EnsuredNonNullabilityResultExpression
 {
 
 	public function __construct(

diff --git a/src/Analyser/Error.php b/src/Analyser/Error.php
@@ -12,7 +12,10 @@
 use function is_bool;
 use function sprintf;
 
-/** @api */
+/**
+ * @api
+ * @final
+ */
 class Error implements JsonSerializable
 {
 

diff --git a/src/Analyser/ExpressionContext.php b/src/Analyser/ExpressionContext.php
@@ -4,7 +4,7 @@
 
 use PHPStan\Type\Type;
 
-class ExpressionContext
+final class ExpressionContext
 {
 
 	private function __construct(

diff --git a/src/Analyser/ExpressionResult.php b/src/Analyser/ExpressionResult.php
@@ -2,7 +2,7 @@
 
 namespace PHPStan\Analyser;
 
-class ExpressionResult
+final class ExpressionResult
 {
 
 	/** @var (callable(): MutatingScope)|null */

diff --git a/src/Analyser/ExpressionTypeHolder.php b/src/Analyser/ExpressionTypeHolder.php
@@ -7,7 +7,7 @@
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeCombinator;
 
-class ExpressionTypeHolder
+final class ExpressionTypeHolder
 {
 
 	public function __construct(private Expr $expr, private Type $type, private TrinaryLogic $certainty)

diff --git a/src/Analyser/FileAnalyser.php b/src/Analyser/FileAnalyser.php
@@ -36,7 +36,7 @@
 use const E_USER_WARNING;
 use const E_WARNING;
 
-class FileAnalyser
+final class FileAnalyser
 {
 
 	/** @var list<Error> */

diff --git a/src/Analyser/FileAnalyserResult.php b/src/Analyser/FileAnalyserResult.php
@@ -8,7 +8,7 @@
 /**
  * @phpstan-type LinesToIgnore = array<string, array<int, non-empty-list<string>|null>>
  */
-class FileAnalyserResult
+final class FileAnalyserResult
 {
 
 	/**

diff --git a/src/Analyser/FinalizerResult.php b/src/Analyser/FinalizerResult.php
@@ -2,7 +2,7 @@
 
 namespace PHPStan\Analyser;
 
-class FinalizerResult
+final class FinalizerResult
 {
 
 	/**

diff --git a/src/Analyser/Ignore/IgnoreParseException.php b/src/Analyser/Ignore/IgnoreParseException.php
@@ -4,7 +4,7 @@
 
 use Exception;
 
-class IgnoreParseException extends Exception
+final class IgnoreParseException extends Exception
 {
 
 	public function __construct(string $message, private int $phpDocLine)

diff --git a/src/Analyser/Ignore/IgnoredError.php b/src/Analyser/Ignore/IgnoredError.php
@@ -14,7 +14,7 @@
 use function sprintf;
 use function str_replace;
 
-class IgnoredError
+final class IgnoredError
 {
 
 	/**

diff --git a/src/Analyser/Ignore/IgnoredErrorHelper.php b/src/Analyser/Ignore/IgnoredErrorHelper.php
@@ -12,7 +12,7 @@
 use function is_file;
 use function sprintf;
 
-class IgnoredErrorHelper
+final class IgnoredErrorHelper
 {
 
 	/**

diff --git a/src/Analyser/Ignore/IgnoredErrorHelperProcessedResult.php b/src/Analyser/Ignore/IgnoredErrorHelperProcessedResult.php
@@ -4,7 +4,7 @@
 
 use PHPStan\Analyser\Error;
 
-class IgnoredErrorHelperProcessedResult
+final class IgnoredErrorHelperProcessedResult
 {
 
 	/**

diff --git a/src/Analyser/Ignore/IgnoredErrorHelperResult.php b/src/Analyser/Ignore/IgnoredErrorHelperResult.php
@@ -13,7 +13,7 @@
 use function is_string;
 use function sprintf;
 
-class IgnoredErrorHelperResult
+final class IgnoredErrorHelperResult
 {
 
 	/**

diff --git a/src/Analyser/ImpurePoint.php b/src/Analyser/ImpurePoint.php
@@ -8,6 +8,7 @@
 /**
  * @phpstan-type ImpurePointIdentifier = 'echo'|'die'|'exit'|'propertyAssign'|'propertyAssignByRef'|'propertyUnset'|'methodCall'|'new'|'functionCall'|'include'|'require'|'print'|'eval'|'superglobal'|'yield'|'yieldFrom'|'static'|'global'|'betweenPhpTags'
  * @api
+ * @final
  */
 class ImpurePoint
 {

diff --git a/src/Analyser/InternalError.php b/src/Analyser/InternalError.php
@@ -10,6 +10,7 @@
 
 /**
  * @api
+ * @final
  * @phpstan-type Trace = list<array{file: string|null, line: int|null}>
  */
 class InternalError implements JsonSerializable

diff --git a/src/Analyser/LazyInternalScopeFactory.php b/src/Analyser/LazyInternalScopeFactory.php
@@ -17,7 +17,7 @@
 use PHPStan\ShouldNotHappenException;
 use function is_a;
 
-class LazyInternalScopeFactory implements InternalScopeFactory
+final class LazyInternalScopeFactory implements InternalScopeFactory
 {
 
 	private bool $explicitMixedInUnknownGenericNew;

diff --git a/src/Analyser/LocalIgnoresProcessor.php b/src/Analyser/LocalIgnoresProcessor.php
@@ -10,7 +10,7 @@
 /**
  * @phpstan-import-type LinesToIgnore from FileAnalyserResult
  */
-class LocalIgnoresProcessor
+final class LocalIgnoresProcessor
 {
 
 	/**

diff --git a/src/Analyser/LocalIgnoresProcessorResult.php b/src/Analyser/LocalIgnoresProcessorResult.php
@@ -5,7 +5,7 @@
 /**
  * @phpstan-import-type LinesToIgnore from FileAnalyserResult
  */
-class LocalIgnoresProcessorResult
+final class LocalIgnoresProcessorResult
 {
 
 	/**

diff --git a/src/Analyser/MutatingScope.php b/src/Analyser/MutatingScope.php
@@ -158,7 +158,7 @@
 use const PHP_INT_MAX;
 use const PHP_INT_MIN;
 
-class MutatingScope implements Scope
+final class MutatingScope implements Scope
 {
 
 	private const BOOLEAN_EXPRESSION_MAX_PROCESS_DEPTH = 4;

diff --git a/src/Analyser/NameScope.php b/src/Analyser/NameScope.php
@@ -16,7 +16,10 @@
 use function str_starts_with;
 use function strtolower;
 
-/** @api */
+/**
+ * @api
+ * @final
+ */
 class NameScope
 {
 

diff --git a/src/Analyser/NodeScopeResolver.php b/src/Analyser/NodeScopeResolver.php
@@ -211,7 +211,7 @@
 use const PHP_VERSION_ID;
 use const SORT_NUMERIC;
 
-class NodeScopeResolver
+final class NodeScopeResolver
 {
 
 	private const LOOP_SCOPE_ITERATIONS = 3;

diff --git a/src/Analyser/NullsafeOperatorHelper.php b/src/Analyser/NullsafeOperatorHelper.php
@@ -5,7 +5,7 @@
 use PhpParser\Node\Expr;
 use PHPStan\Type\TypeCombinator;
 
-class NullsafeOperatorHelper
+final class NullsafeOperatorHelper
 {
 
 	public static function getNullsafeShortcircuitedExprRespectingScope(Scope $scope, Expr $expr): Expr

diff --git a/src/Analyser/OutOfClassScope.php b/src/Analyser/OutOfClassScope.php
@@ -8,7 +8,7 @@
 use PHPStan\Reflection\MethodReflection;
 use PHPStan\Reflection\PropertyReflection;
 
-class OutOfClassScope implements ClassMemberAccessAnswerer
+final class OutOfClassScope implements ClassMemberAccessAnswerer
 {
 
 	/** @api */

diff --git a/src/Analyser/ProcessClosureResult.php b/src/Analyser/ProcessClosureResult.php
@@ -4,7 +4,7 @@
 
 use PHPStan\Node\InvalidateExprNode;
 
-class ProcessClosureResult
+final class ProcessClosureResult
 {
 
 	/**

diff --git a/src/Analyser/ResultCache/ResultCache.php b/src/Analyser/ResultCache/ResultCache.php
@@ -10,7 +10,7 @@
 /**
  * @phpstan-import-type LinesToIgnore from FileAnalyserResult
  */
-class ResultCache
+final class ResultCache
 {
 
 	/**

diff --git a/src/Analyser/ResultCache/ResultCacheClearer.php b/src/Analyser/ResultCache/ResultCacheClearer.php
@@ -6,7 +6,7 @@
 use function is_file;
 use function unlink;
 
-class ResultCacheClearer
+final class ResultCacheClearer
 {
 
 	public function __construct(private string $cacheFilePath)

diff --git a/src/Analyser/ResultCache/ResultCacheManager.php b/src/Analyser/ResultCache/ResultCacheManager.php
@@ -47,7 +47,7 @@
 /**
  * @phpstan-import-type LinesToIgnore from FileAnalyserResult
  */
-class ResultCacheManager
+final class ResultCacheManager
 {
 
 	private const CACHE_VERSION = 'v12-linesToIgnore';

diff --git a/src/Analyser/ResultCache/ResultCacheProcessResult.php b/src/Analyser/ResultCache/ResultCacheProcessResult.php
@@ -4,7 +4,7 @@
 
 use PHPStan\Analyser\AnalyserResult;
 
-class ResultCacheProcessResult
+final class ResultCacheProcessResult
 {
 
 	public function __construct(private AnalyserResult $analyserResult, private bool $saved)

diff --git a/src/Analyser/RuleErrorTransformer.php b/src/Analyser/RuleErrorTransformer.php
@@ -12,7 +12,7 @@
 use PHPStan\Rules\TipRuleError;
 use function is_string;
 
-class RuleErrorTransformer
+final class RuleErrorTransformer
 {
 
 	/**
-Original file line number
+Diff line change
@@ Expand Up / @@ -14,7 +14,7 @@ @@
     /**
      * @internal Use PHPStan\Rules\RuleErrorBuilder instead.
      */
-    class RuleError%s implements %s
+    final class RuleError%s implements %s
     {
     	%s
@@ Expand Down @@