Mark class-constants as non-deprecated #7
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Static analysis tools like PHPStan treat the `@deprecated` flag as inherited. So when a class constant is marked as deprecated, then the same class constant in an extending class is also marked deprecated unless it gets explicitly marked as `@non-deprecated`. Without this flag PHPStan will return the message Fetching deprecated class constant LAST_USERNAME of class Symfony\Bundle\SecurityBundle\Security: since Symfony 6.2, use \Symfony\Bundle\SecurityBundle\Security::LAST_USERNAME instead which is not really helpful as that is exactly what one did at that point. By marking these class-constants as @non-deprecated PHPStan and other static analysis tools can recognize these class constants as being the rightly used ones. For more information have a look at the discussion at phpstan/phpstan-deprecation-rules#100
|
Thanks for your pull request! We love contributions. However, you should instead open a pull request on the main repository: https://github.com/symfony/symfony This repository is what we call a "subtree split": a read-only subset of that main repository. We're looking forward to your PR there! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Static analysis tools like PHPStan treat the
@deprecatedflag as inherited. So when a class constant is marked as deprecated, then the same class constant in an extending class is also marked deprecated unless it gets explicitly marked as@non-deprecated.Without this flag PHPStan will return the message
which is not really helpful as that is exactly what one did at that point.
By marking these class-constants as
@non-deprecatedPHPStan and other static analysis tools can recognize these class constants as being the rightly used ones.For more information have a look at the discussion at phpstan/phpstan-deprecation-rules#100