Support for #[Deprecated()] annotation

[DeyV]

phpstorm-stubs use JetBrains\PhpStorm\Deprecated annotation to mark method's, class e.t.c
This annotation allows for more detailed description of the problem and suggested changes.

Other projects use this annotation as well

Can deprecation-rules show it in the same way like @deprecated ?

[cavasinf]

Could be a nice feature!

The today work around: Double @deprecated and #[Deprecated]

/**
 * @deprecated
 */
#[Deprecated("use createFromDateRange() instead", 'DateHelper::createFromDateRange(%parametersList%)')]
public static function fromDateRangePicker(string $dateRangeFormData): array
{
    return self::createFromDateRange($dateRangeFormData);
}

[cavasinf]

Is it hard to implement @ondrejmirtes?

[ondrejmirtes]

It's not hard at all. The issue is that this attribute isn't official in any way. Someone might prefer to use a different attribute (like their own class) for this same purpose so we better make sure this system is extensible like other similar extension types in PHPStan: https://phpstan.org/developing-extensions/extension-types

[mglaman]

Sorry, I hijacked this. The wrong node would be passed in. But using \PHPStan\Analyser\Scope::getFunctionCallStack to find the parent node would allow inspecting the method's attributes in a custom scope resolver.

Old and invalid

I think this would be achievable if `\PHPStan\Rules\Deprecations\DeprecatedScopeHelper` was aware of the node in `\PHPStan\Rules\Deprecations\DeprecatedScopeHelper::isScopeDeprecated`.

A custom deprecated scope resolver could then inspect the node to see if it has the attribute.

The problem is I cannot think of a non-breaking way to introduce a change to \PHPStan\Rules\Deprecations\DeprecatedScopeResolver::isScopeDeprecated

Edit: Passing the node object in would help solve a final problem in mglaman/phpstan-drupal#714 for myself.

I'll propose a PR so we can discuss the code, or just close out the idea.

[staabm]

the native attribute with php 8.4 which was added with https://wiki.php.net/rfc/deprecated_attribute already works like expected

(I just work on adding test-coverage)

[ondrejmirtes]

@staabm It doesn't. I have about 500 LoC commit in my private PHPStan 2.1.x branch that adds proper support for that to PHPStan.

Hopefully it's going to be out still in 2024.

[staabm]

in my local testing it at least reports calls to functions annotated with #[\Deprecated].

will wait for your work then so we don't step onto each others toe

[ondrejmirtes]

Anyone can implement an extension now: phpstan/phpstan-src#3932

[ondrejmirtes]

Also see: https://phpstan.org/developing-extensions/custom-deprecations

[janedbal]

Example extension directly using JetBrains attribute: https://gist.github.com/janedbal/7e7b2b76a101dd8b6c9161dd4d2e1369

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.