phpstan / phpstan-deprecation-rules
PHPStan rules for detecting usage of deprecated classes, methods, properties, constants and traits.
Installs: 44 900 342
Dependents: 4 567
Suggesters: 7
Security: 0
Stars: 378
Watchers: 5
Forks: 19
Open Issues: 16
Type:phpstan-extension
Requires
- php: ^7.4 || ^8.0
- phpstan/phpstan: ^2.0
Requires (Dev)
This package is auto-updated.
Last update: 2024-11-28 21:57:13 UTC
README
Installation
To use this extension, require it in Composer:
composer require --dev phpstan/phpstan-deprecation-rules
If you also install phpstan/extension-installer then you're all set!
Manual installation
If you don't want to use phpstan/extension-installer
, include rules.neon in your project's PHPStan config:
includes:
- vendor/phpstan/phpstan-deprecation-rules/rules.neon
Deprecating code you don't own
This extension emits deprecation warnings on code, which uses properties/functions/methods/classes which are annotated as @deprecated
.
In case you don't own the code which you want to be considered deprecated, use PHPStan Stub Files to declare deprecations for vendor files like:
/** @deprecated */
class ThirdPartyClass {}
Custom deprecated scopes
Usage of deprecated code is not reported in code that is also deprecated:
/** @deprecated */ function doFoo(): void { // not reported: anotherDeprecatedFunction(); }
If you have a different way of marking code that calls deprecated symbols on purpose and you don't want these calls to be reported either, you can write an extension by implementing the DeprecatedScopeResolver
interface.
For example if you mark your PHPUnit tests that test deprecated code with @group legacy
, you can implement the extension this way:
class GroupLegacyScopeResolver implements DeprecatedScopeResolver { public function isScopeDeprecated(Scope $scope): bool { $function = $scope->getFunction(); return $function !== null && $function->getDocComment() !== null && strpos($function->getDocComment(), '@group legacy') !== false; } }
And register it in your configuration file:
services: - class: GroupLegacyScopeResolver tags: - phpstan.deprecations.deprecatedScopeResolver
Learn more about Scope, a core concept for implementing custom PHPStan extensions.