Skip to content

Latest commit

 

History

History
281 lines (276 loc) · 15.5 KB

UPGRADING.md

File metadata and controls

281 lines (276 loc) · 15.5 KB
Raw

Upgrading from Psalm 4 to Psalm 5

Changed

  • [BC] TPositiveInt has been removed and replaced by TIntRange

  • [BC] The parameter $php_version of Psalm\Type\Atomic::create() renamed to $analysis_php_version_id and changed from array|null to int|null. Previously it accepted PHP version as array{major_version, minor_version} while now it accepts version ID, similar to how PHP_VERSION_ID is calculated.

  • [BC] The parameter $php_version of Psalm\Type::parseString() renamed to $analysis_php_version_id and changed from array|null to int|null. Previously it accepted PHP version as array{major_version, minor_version} while now it accepts version ID.

  • [BC] Parameter 0 of canBeFullyExpressedInPhp() of the classes listed below changed name from php_major_version to analysis_php_version_id. Previously it accepted major PHP version as int (e.g. 7), while now it accepts version ID. Classes affected:

    • Psalm\Type\Atomic
    • Psalm\Type\Atomic\Scalar
    • Psalm\Type\Atomic\TArray
    • Psalm\Type\Atomic\TArrayKey
    • Psalm\Type\Atomic\TCallable
    • Psalm\Type\Atomic\TCallableObject
    • Psalm\Type\Atomic\TCallableString
    • Psalm\Type\Atomic\TClassConstant
    • Psalm\Type\Atomic\TClassString
    • Psalm\Type\Atomic\TClassStringMap
    • Psalm\Type\Atomic\TClosedResource
    • Psalm\Type\Atomic\TClosure
    • Psalm\Type\Atomic\TConditional
    • Psalm\Type\Atomic\TDependentGetClass
    • Psalm\Type\Atomic\TDependentGetDebugType
    • Psalm\Type\Atomic\TDependentGetType
    • Psalm\Type\Atomic\TDependentListKey
    • Psalm\Type\Atomic\TEnumCase
    • Psalm\Type\Atomic\TFalse
    • Psalm\Type\Atomic\TGenericObject
    • Psalm\Type\Atomic\TIntMask
    • Psalm\Type\Atomic\TIntMaskOf
    • Psalm\Type\Atomic\TIntRange
    • Psalm\Type\Atomic\TIterable
    • Psalm\Type\Atomic\TKeyedArray
    • Psalm\Type\Atomic\TKeyOfArray
    • Psalm\Type\Atomic\TList
    • Psalm\Type\Atomic\TLiteralClassString
    • Psalm\Type\Atomic\TLowercaseString
    • Psalm\Type\Atomic\TMixed
    • Psalm\Type\Atomic\TNamedObject
    • Psalm\Type\Atomic\TNever
    • Psalm\Type\Atomic\TNonEmptyLowercaseString
    • Psalm\Type\Atomic\TNonspecificLiteralInt
    • Psalm\Type\Atomic\TNonspecificLiteralString
    • Psalm\Type\Atomic\TNull
    • Psalm\Type\Atomic\TNumeric
    • Psalm\Type\Atomic\TNumericString
    • Psalm\Type\Atomic\TObject
    • Psalm\Type\Atomic\TObjectWithProperties
    • Psalm\Type\Atomic\TResource
    • Psalm\Type\Atomic\TScalar
    • Psalm\Type\Atomic\TTemplateIndexedAccess
    • Psalm\Type\Atomic\TTemplateParam
    • Psalm\Type\Atomic\TTraitString
    • Psalm\Type\Atomic\TTrue
    • Psalm\Type\Atomic\TTypeAlias
    • Psalm\Type\Atomic\TValueOfArray
    • Psalm\Type\Atomic\TVoid
    • Psalm\Type\Union

  • [BC] Parameter 3 of toPhpString() of methods listed below changed name from php_major_version to analysis_php_version_id. Previously it accepted major PHP version as int (e.g. 7), while now it accepts version ID. Classes affected:

    • Psalm\Type\Atomic
    • Psalm\Type\Atomic\CallableTrait
    • Psalm\Type\Atomic\TAnonymousClassInstance
    • Psalm\Type\Atomic\TArray
    • Psalm\Type\Atomic\TArrayKey
    • Psalm\Type\Atomic\TBool
    • Psalm\Type\Atomic\TCallable
    • Psalm\Type\Atomic\TCallableObject
    • Psalm\Type\Atomic\TClassConstant
    • Psalm\Type\Atomic\TClassString
    • Psalm\Type\Atomic\TClassStringMap
    • Psalm\Type\Atomic\TClosedResource
    • Psalm\Type\Atomic\TConditional
    • Psalm\Type\Atomic\TEmpty
    • Psalm\Type\Atomic\TEnumCase
    • Psalm\Type\Atomic\TFloat
    • Psalm\Type\Atomic\TGenericObject
    • Psalm\Type\Atomic\TInt
    • Psalm\Type\Atomic\TIterable
    • Psalm\Type\Atomic\TKeyedArray
    • Psalm\Type\Atomic\TKeyOfArray
    • Psalm\Type\Atomic\TList
    • Psalm\Type\Atomic\TLiteralClassString
    • Psalm\Type\Atomic\TMixed
    • Psalm\Type\Atomic\TNamedObject
    • Psalm\Type\Atomic\TNever
    • Psalm\Type\Atomic\TNull
    • Psalm\Type\Atomic\TNumeric
    • Psalm\Type\Atomic\TObject
    • Psalm\Type\Atomic\TObjectWithProperties
    • Psalm\Type\Atomic\TResource
    • Psalm\Type\Atomic\TScalar
    • Psalm\Type\Atomic\TString
    • Psalm\Type\Atomic\TTemplateIndexedAccess
    • Psalm\Type\Atomic\TTemplateParam
    • Psalm\Type\Atomic\TTraitString
    • Psalm\Type\Atomic\TTypeAlias
    • Psalm\Type\Atomic\TValueOfArray
    • Psalm\Type\Atomic\TVoid
    • Psalm\Type\Union

  • While not a BC break per se, all classes / interfaces / traits / enums under Psalm\Internal namespace are now marked @internal.

  • [BC] Parameter 1 of Psalm\Type\Atomic\TNamedObject::__construct() changed name from was_static to is_static

  • [BC] Parameter 1 of Psalm\Type\Atomic\TAnonymousClassInstance::__construct() changed name from was_static to is_static

  • [BC] Parameter 5 of Psalm\Type::getStringFromFQCLN() changed name from was_static to is_static

  • [BC] Property Psalm\Type\Atomic\TNamedObject::$was_static was renamed to $is_static

  • [BC] Method Psalm\Type\Union::isFormerStaticObject() was renamed to isStaticObject()

  • [BC] Method Psalm\Type\Union::hasFormerStaticObject() was renamed to hasStaticObject()

  • [BC] Function assertions (from @psalm-assert Foo $bar) have been converted from strings to specific Assertion objects.

  • [BC] Property Psalm\Storage\ClassLikeStorage::$invalid_dependencies changed from array<string> to array<string, true>.

  • [BC] Property Psalm\Storage\ClassLikeStorage::$template_extended_count was renamed to $template_type_extends_count, its type was changed from int|null to array<string, int>|null.

  • [BC] Event classes became final and their constructors were marked @internal:

    • Psalm\Plugin\EventHandler\Event\AddRemoveTaintsEvent
    • Psalm\Plugin\EventHandler\Event\AfterAnalysisEvent
    • Psalm\Plugin\EventHandler\Event\AfterClassLikeAnalysisEvent
    • Psalm\Plugin\EventHandler\Event\AfterClassLikeExistenceCheckEvent
    • Psalm\Plugin\EventHandler\Event\AfterClassLikeVisitEvent
    • Psalm\Plugin\EventHandler\Event\AfterCodebasePopulatedEvent
    • Psalm\Plugin\EventHandler\Event\AfterEveryFunctionCallAnalysisEvent
    • Psalm\Plugin\EventHandler\Event\AfterExpressionAnalysisEvent
    • Psalm\Plugin\EventHandler\Event\AfterFileAnalysisEvent
    • Psalm\Plugin\EventHandler\Event\AfterFunctionCallAnalysisEvent
    • Psalm\Plugin\EventHandler\Event\AfterFunctionLikeAnalysisEvent
    • Psalm\Plugin\EventHandler\Event\AfterMethodCallAnalysisEvent
    • Psalm\Plugin\EventHandler\Event\AfterStatementAnalysisEvent
    • Psalm\Plugin\EventHandler\Event\BeforeFileAnalysisEvent
    • Psalm\Plugin\EventHandler\Event\FunctionExistenceProviderEvent
    • Psalm\Plugin\EventHandler\Event\FunctionParamsProviderEvent
    • Psalm\Plugin\EventHandler\Event\FunctionReturnTypeProviderEvent
    • Psalm\Plugin\EventHandler\Event\MethodExistenceProviderEvent
    • Psalm\Plugin\EventHandler\Event\MethodParamsProviderEvent
    • Psalm\Plugin\EventHandler\Event\MethodReturnTypeProviderEvent
    • Psalm\Plugin\EventHandler\Event\MethodVisibilityProviderEvent
    • Psalm\Plugin\EventHandler\Event\PropertyExistenceProviderEvent
    • Psalm\Plugin\EventHandler\Event\PropertyTypeProviderEvent
    • Psalm\Plugin\EventHandler\Event\PropertyVisibilityProviderEvent
    • Psalm\Plugin\EventHandler\Event\StringInterpreterEvent

  • [BC] Atomic::__toString() used to return a string representation of the type that was using double quotes (") to quote literals. This is now using single quotes (') to be more aligned with the rest of the codebase.

  • [BC] Atomic::__toString() is now final

  • [BC] Atomic::__toString() now returns a more detailed version of the type (it calls getId() under the hood)

  • [BC] Atomic::getId() has now a first param $exact. Calling the method with false will return a less detailed version of the type in some cases (similarly to what __toString used to return)

  • [BC] To remove a variable from the context, Context::remove(). Calling unset($context->vars_in_scope[$var_id]) can cause problems when using references.

  • [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 Psalm\Codebase::$analysis_php_version_id.
  • [BC] Property Psalm\Codebase::$php_minor_version was removed, use Psalm\Codebase::$analysis_php_version_id.
  • [BC] Class Psalm\Type\Atomic\TEmpty was removed
  • [BC] Method Psalm\Type\Union::isEmpty() was removed
  • [BC] Property Psalm\Config::$allow_phpstorm_generics was removed
  • [BC] Property Psalm\Config::$exit_functions was removed
  • [BC] Property Psalm\Config::$forbid_echo was removed
  • [BC] Property Psalm\Config::$load_xdebug_stub was removed
  • [BC] Method Psalm\Type::getEmpty() was removed
  • [BC] Legacy hook interfaces have been removed:
    • Psalm\Plugin\Hook\MethodReturnTypeProviderInterface
    • Psalm\Plugin\Hook\BeforeFileAnalysisInterface
    • Psalm\Plugin\Hook\AfterFileAnalysisInterface
    • Psalm\Plugin\Hook\AfterMethodCallAnalysisInterface
    • Psalm\Plugin\Hook\AfterClassLikeVisitInterface
    • Psalm\Plugin\Hook\StringInterpreterInterface
    • Psalm\Plugin\Hook\AfterExpressionAnalysisInterface
    • Psalm\Plugin\Hook\AfterEveryFunctionCallAnalysisInterface
    • Psalm\Plugin\Hook\PropertyExistenceProviderInterface
    • Psalm\Plugin\Hook\AfterFunctionLikeAnalysisInterface
    • Psalm\Plugin\Hook\FunctionParamsProviderInterface
    • Psalm\Plugin\Hook\FunctionReturnTypeProviderInterface
    • Psalm\Plugin\Hook\FunctionExistenceProviderInterface
    • Psalm\Plugin\Hook\AfterAnalysisInterface
    • Psalm\Plugin\Hook\MethodVisibilityProviderInterface
    • Psalm\Plugin\Hook\MethodParamsProviderInterface
    • Psalm\Plugin\Hook\AfterClassLikeExistenceCheckInterface
    • Psalm\Plugin\Hook\PropertyTypeProviderInterface
    • Psalm\Plugin\Hook\AfterFunctionCallAnalysisInterface
    • Psalm\Plugin\Hook\MethodExistenceProviderInterface
    • Psalm\Plugin\Hook\AfterCodebasePopulatedInterface
    • Psalm\Plugin\Hook\AfterClassLikeAnalysisInterface
    • Psalm\Plugin\Hook\PropertyVisibilityProviderInterface
    • Psalm\Plugin\Hook\AfterStatementAnalysisInterface
  • [BC] Method Psalm\Issue\CodeIssue::getLocation() was removed
  • [BC] Method Psalm\Issue\CodeIssue::getFileName() was removed
  • [BC] Method Psalm\Issue\CodeIssue::getMessage() was removed
  • [BC] Method Psalm\DocComment::parse() was removed
  • [BC] Class Psalm\Type\Atomic\THtmlEscapedString has been removed
  • [BC] Property Psalm\Context::$vars_from_global has been renamed to $referenced_globals
  • [BC] Self-registration of file type scanners and file type analyzers has been changed
    • Psalm\Plugin\RegistrationInterface::addFileTypeScanner was removed
    • Psalm\Plugin\RegistrationInterface::addFileTypeAnalyzer was removed
    • ℹ️ migration possible using Psalm\Plugin\FileExtensionsInterface
    • Psalm\PluginRegistrationSocket::addFileTypeScanner was removed
    • Psalm\PluginRegistrationSocket::getAdditionalFileTypeScanners was removed
    • Psalm\PluginRegistrationSocket::addFileTypeAnalyzer was removed
    • Psalm\PluginRegistrationSocket::getAdditionalFileTypeAnalyzers was removed
    • Psalm\PluginRegistrationSocket::getAdditionalFileExtensions was removed
    • Psalm\PluginRegistrationSocket::addFileExtension was removed
    • ℹ️ migration possible using Psalm\PluginFileExtensionsSocket
  • [BC] Method \Psalm\Plugin\EventHandler\Event\AfterFunctionLikeAnalysisEvent::getClasslikeStorage() was removed, use correct \Psalm\Plugin\EventHandler\Event\AfterFunctionLikeAnalysisEvent::getFunctionlikeStorage() instead