Merge pull request #7578 from weirdan/finalize-more-classes

UPGRADING.md

@@ -158,6 +158,70 @@
 - [BC] `TKeyOfClassConstant` has been renamed to `TKeyOfArray`.
 - [BC] `TValueOfClassConstant` has been renamed to `TValueOfArray`.
 - [BC] `TKeyOfTemplate` base class has been changed from `Scalar` to `Atomic`.
+- [BC] Class `Psalm\FileManipulation` became final
+- [BC] Class `Psalm\Context` became final
+- [BC] `Psalm\Context#__construct()` was marked `@internal`
+- [BC] Class `Psalm\PluginRegistrationSocket` became final
+- [BC] Class `Psalm\PluginFileExtensionsSocket` became final
+- [BC] Class `Psalm\Config\IssueHandler` became final
+- [BC] `Psalm\Config\IssueHandler` was marked `@internal`
+- [BC] Class `Psalm\Config\ProjectFileFilter` became final
+- [BC] `Psalm\Config\ProjectFileFilter` was marked `@internal`
+- [BC] Class `Psalm\Config\Creator` became final
+- [BC] `Psalm\Config\Creator` was marked `@internal`
+- [BC] Class `Psalm\Config\TaintAnalysisFileFilter` became final
+- [BC] `Psalm\Config\TaintAnalysisFileFilter` was marked `@internal`
+- [BC] Class `Psalm\Config\ErrorLevelFileFilter` became final
+- [BC] `Psalm\Config\ErrorLevelFileFilter` was marked `@internal`
+- [BC] Class `Psalm\FileBasedPluginAdapter` became final
+- [BC] `Psalm\FileBasedPluginAdapter` was marked `@internal`
+- [BC] Class `Psalm\Exception\InvalidMethodOverrideException` became final
+- [BC] Class `Psalm\Exception\UnpopulatedClasslikeException` became final
+- [BC] Class `Psalm\Exception\ConfigNotFoundException` became final
+- [BC] Class `Psalm\Exception\TypeParseTreeException` became final
+- [BC] Class `Psalm\Exception\ComplicatedExpressionException` became final
+- [BC] Class `Psalm\Exception\ScopeAnalysisException` became final
+- [BC] Class `Psalm\Exception\InvalidClasslikeOverrideException` became final
+- [BC] Class `Psalm\Exception\CircularReferenceException` became final
+- [BC] Class `Psalm\Exception\UnsupportedIssueToFixException` became final
+- [BC] Class `Psalm\Exception\CodeException` became final
+- [BC] Class `Psalm\Exception\RefactorException` became final
+- [BC] Class `Psalm\Exception\UnpreparedAnalysisException` became final
+- [BC] Class `Psalm\Exception\IncorrectDocblockException` became final
+- [BC] Class `Psalm\Exception\UnanalyzedFileException` became final
+- [BC] Class `Psalm\Exception\UnresolvableConstantException` became final
+- [BC] Class `Psalm\Exception\FileIncludeException` became final
+- [BC] Class `Psalm\Exception\ConfigCreationException` became final
+- [BC] Class `Psalm\Aliases` became final
+- [BC] `Psalm\Aliases#__construct()` was marked `@internal`
+- [BC] Class `Psalm\Codebase` became final
+- [BC] `Psalm\Codebase#__construct()` was marked `@internal`
+- [BC] Class `Psalm\Progress\VoidProgress` became final
+- [BC] Class `Psalm\Progress\DebugProgress` became final
+- [BC] Class `Psalm\Report\JsonReport` became final
+- [BC] Class `Psalm\Report\SonarqubeReport` became final
+- [BC] Class `Psalm\Report\CodeClimateReport` became final
+- [BC] Class `Psalm\Report\CheckstyleReport` became final
+- [BC] Class `Psalm\Report\JsonSummaryReport` became final
+- [BC] Class `Psalm\Report\XmlReport` became final
+- [BC] Class `Psalm\Report\EmacsReport` became final
+- [BC] Class `Psalm\Report\ConsoleReport` became final
+- [BC] Class `Psalm\Report\ReportOptions` became final
+- [BC] Class `Psalm\Report\PylintReport` became final
+- [BC] Class `Psalm\Report\JunitReport` became final
+- [BC] Class `Psalm\Report\CompactReport` became final
+- [BC] Class `Psalm\Report\GithubActionsReport` became final
+- [BC] Class `Psalm\Report\TextReport` became final
+- [BC] Class `Psalm\Report\SarifReport` became final
+- [BC] Class `Psalm\Report\PhpStormReport` became final
+- [BC] Class `Psalm\Plugin\Shepherd` became final
+- [BC] Class `Psalm\IssueBuffer` became final
+- [BC] Class `Psalm\SourceControl\Git\RemoteInfo` became final
+- [BC] Class `Psalm\SourceControl\Git\CommitInfo` became final
+- [BC] Class `Psalm\SourceControl\Git\GitInfo` became final
+- [BC] Class `Psalm\ErrorBaseline` became final
+- [BC] `Psalm\Config#__construct()` was marked `@internal`
+- [BC] Class `Psalm\DocComment` became final
 
 ## Removed
  - [BC] Property `Psalm\Codebase::$php_major_version` was removed, use

src/Psalm/Aliases.php

@@ -2,7 +2,7 @@
 
 namespace Psalm;
 
-class Aliases
+final class Aliases
 {
     /**
      * @var array<lowercase-string, string>
@@ -53,6 +53,7 @@ class Aliases
      * @param array<lowercase-string, string> $uses_flipped
      * @param array<lowercase-string, string> $functions_flipped
      * @param array<string, string> $constants_flipped
+     * @internal
      */
     public function __construct(
         ?string $namespace = null,

src/Psalm/Codebase.php

@@ -92,7 +92,7 @@
 
 use const PHP_VERSION_ID;
 
-class Codebase
+final class Codebase
 {
     /**
      * @var Config
@@ -314,6 +314,7 @@ class Codebase
      */
     public $track_unused_suppressions = false;
 
+    /** @internal */
     public function __construct(
         Config $config,
         Providers $providers,

src/Psalm/Config.php

@@ -608,6 +608,7 @@ class Config
      */
     private $plugins = [];
 
+    /** @internal */
     protected function __construct()
     {
         self::$instance = $this;

src/Psalm/Config/Creator.php

@@ -35,7 +35,8 @@
 use const GLOB_NOSORT;
 use const JSON_THROW_ON_ERROR;
 
-class Creator
+/** @internal */
+final class Creator
 {
     private const TEMPLATE = '<?xml version="1.0"?>
 <psalm

src/Psalm/Config/ErrorLevelFileFilter.php

@@ -8,7 +8,8 @@
 
 use function in_array;
 
-class ErrorLevelFileFilter extends FileFilter
+/** @internal */
+final class ErrorLevelFileFilter extends FileFilter
 {
     /**
      * @var string

src/Psalm/Config/IssueHandler.php

@@ -16,7 +16,8 @@
 
 use const SCANDIR_SORT_NONE;
 
-class IssueHandler
+/** @internal */
+final class IssueHandler
 {
     /**
      * @var string

src/Psalm/Config/ProjectFileFilter.php

@@ -8,7 +8,8 @@
 use function stripos;
 use function strpos;
 
-class ProjectFileFilter extends FileFilter
+/** @internal */
+final class ProjectFileFilter extends FileFilter
 {
     /**
      * @var ProjectFileFilter|null

src/Psalm/Config/TaintAnalysisFileFilter.php

@@ -2,6 +2,7 @@
 
 namespace Psalm\Config;
 
-class TaintAnalysisFileFilter extends FileFilter
+/** @internal */
+final class TaintAnalysisFileFilter extends FileFilter
 {
 }

src/Psalm/Context.php

@@ -31,7 +31,7 @@
 
 use const JSON_THROW_ON_ERROR;
 
-class Context
+final class Context
 {
     /**
      * @var array<string, Union>
@@ -413,6 +413,7 @@ class Context
      */
     public $parent_remove_vars = [];
 
+    /** @internal */
     public function __construct(?string $self = null)
     {
         $this->self = $self;

src/Psalm/DocComment.php

@@ -16,7 +16,7 @@
 use function substr;
 use function trim;
 
-class DocComment
+final class DocComment
 {
     public const PSALM_ANNOTATIONS = [
         'return', 'param', 'template', 'var', 'type',

src/Psalm/ErrorBaseline.php

@@ -30,7 +30,7 @@
 use const LIBXML_NOBLANKS;
 use const PHP_VERSION;
 
-class ErrorBaseline
+final class ErrorBaseline
 {
     /**
      * @param array<string,array<string,array{o:int, s:array<int, string>}>> $existingIssues

src/Psalm/Exception/CircularReferenceException.php

@@ -4,6 +4,6 @@
 
 use Exception;
 
-class CircularReferenceException extends Exception
+final class CircularReferenceException extends Exception
 {
 }

src/Psalm/Exception/CodeException.php

@@ -4,6 +4,6 @@
 
 use Exception;
 
-class CodeException extends Exception
+final class CodeException extends Exception
 {
 }

src/Psalm/Exception/ComplicatedExpressionException.php

@@ -4,6 +4,6 @@
 
 use Exception;
 
-class ComplicatedExpressionException extends Exception
+final class ComplicatedExpressionException extends Exception
 {
 }

src/Psalm/Exception/ConfigCreationException.php

@@ -4,6 +4,6 @@
 
 use Exception;
 
-class ConfigCreationException extends Exception
+final class ConfigCreationException extends Exception
 {
 }

src/Psalm/Exception/ConfigNotFoundException.php

@@ -2,6 +2,6 @@
 
 namespace Psalm\Exception;
 
-class ConfigNotFoundException extends ConfigException
+final class ConfigNotFoundException extends ConfigException
 {
 }

src/Psalm/Exception/FileIncludeException.php

@@ -4,6 +4,6 @@
 
 use Exception;
 
-class FileIncludeException extends Exception
+final class FileIncludeException extends Exception
 {
 }

src/Psalm/Exception/IncorrectDocblockException.php

@@ -2,6 +2,6 @@
 
 namespace Psalm\Exception;
 
-class IncorrectDocblockException extends DocblockParseException
+final class IncorrectDocblockException extends DocblockParseException
 {
 }

src/Psalm/Exception/InvalidClasslikeOverrideException.php

@@ -4,6 +4,6 @@
 
 use Exception;
 
-class InvalidClasslikeOverrideException extends Exception
+final class InvalidClasslikeOverrideException extends Exception
 {
 }

src/Psalm/Exception/InvalidMethodOverrideException.php

@@ -4,6 +4,6 @@
 
 use Exception;
 
-class InvalidMethodOverrideException extends Exception
+final class InvalidMethodOverrideException extends Exception
 {
 }

src/Psalm/Exception/RefactorException.php

@@ -4,6 +4,6 @@
 
 use Exception;
 
-class RefactorException extends Exception
+final class RefactorException extends Exception
 {
 }

src/Psalm/Exception/ScopeAnalysisException.php

@@ -4,6 +4,6 @@
 
 use Exception;
 
-class ScopeAnalysisException extends Exception
+final class ScopeAnalysisException extends Exception
 {
 }

src/Psalm/Exception/TypeParseTreeException.php

@@ -4,6 +4,6 @@
 
 use Exception;
 
-class TypeParseTreeException extends Exception
+final class TypeParseTreeException extends Exception
 {
 }

src/Psalm/Exception/UnanalyzedFileException.php

@@ -4,6 +4,6 @@
 
 use Exception;
 
-class UnanalyzedFileException extends Exception
+final class UnanalyzedFileException extends Exception
 {
 }

src/Psalm/Exception/UnpopulatedClasslikeException.php

@@ -4,7 +4,7 @@
 
 use LogicException;
 
-class UnpopulatedClasslikeException extends LogicException
+final class UnpopulatedClasslikeException extends LogicException
 {
     public function __construct(string $fq_classlike_name)
     {

src/Psalm/Exception/UnpreparedAnalysisException.php

@@ -4,6 +4,6 @@
 
 use Exception;
 
-class UnpreparedAnalysisException extends Exception
+final class UnpreparedAnalysisException extends Exception
 {
 }

src/Psalm/Exception/UnresolvableConstantException.php

@@ -4,7 +4,7 @@
 
 use Exception;
 
-class UnresolvableConstantException extends Exception
+final class UnresolvableConstantException extends Exception
 {
     /**
      * @var string

src/Psalm/Exception/UnsupportedIssueToFixException.php

@@ -4,7 +4,7 @@
 
 use Exception;
 
-class UnsupportedIssueToFixException extends Exception
+final class UnsupportedIssueToFixException extends Exception
 {
 
 }

src/Psalm/FileBasedPluginAdapter.php

@@ -16,7 +16,8 @@
 
 use const DIRECTORY_SEPARATOR;
 
-class FileBasedPluginAdapter implements PluginEntryPointInterface
+/** @internal */
+final class FileBasedPluginAdapter implements PluginEntryPointInterface
 {
     /** @var string */
     private $path;

src/Psalm/FileManipulation.php

@@ -8,7 +8,7 @@
 use function substr;
 use function trim;
 
-class FileManipulation
+final class FileManipulation
 {
     /** @var int */
     public $start;

src/Psalm/IssueBuffer.php

@@ -77,7 +77,7 @@
 use const PSALM_VERSION;
 use const STDERR;
 
-class IssueBuffer
+final class IssueBuffer
 {
     /**
      * @var array<string, list<IssueData>>

src/Psalm/Plugin/Shepherd.php

@@ -34,7 +34,7 @@
 use const PHP_URL_SCHEME;
 use const STDERR;
 
-class Shepherd implements AfterAnalysisInterface
+final class Shepherd implements AfterAnalysisInterface
 {
     /**
      * Called after analysis is complete

src/Psalm/PluginFileExtensionsSocket.php

@@ -12,7 +12,7 @@
 use function is_a;
 use function sprintf;
 
-class PluginFileExtensionsSocket implements FileExtensionsInterface
+final class PluginFileExtensionsSocket implements FileExtensionsInterface
 {
     /**
      * @var Config

src/Psalm/PluginRegistrationSocket.php

@@ -19,7 +19,7 @@
 use function class_exists;
 use function is_subclass_of;
 
-class PluginRegistrationSocket implements RegistrationInterface
+final class PluginRegistrationSocket implements RegistrationInterface
 {
     /** @var Config */
     private $config;

src/Psalm/Progress/DebugProgress.php

@@ -6,7 +6,7 @@
 
 use const E_ALL;
 
-class DebugProgress extends Progress
+final class DebugProgress extends Progress
 {
     public function setErrorReporting(): void
     {