Skip to content

docs: deprecated attribute support and compatibility matrix #185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vinceAmstoutz wants to merge 1 commit into
base: 2.0.x
Choose a base branch
from
+24 −0
Open

docs: deprecated attribute support and compatibility matrix #185

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,14 @@ includes:
```
</details>

## Compatibility with deprecation mechanisms

| Mechanism | Emits runtime deprecation | Supported by PHPStan? |
|---------------------------------------------------------------------------------------|---------------------------|--------------------------|
| `@deprecated` PHPDoc | No | Yes — via this extension |
| `#[\Deprecated]`, [since PHP 8.4](https://www.php.net/manual/en/class.deprecated.php) | Yes | Yes — via this extension |
| `trigger_deprecation()` | Yes | No |

## Deprecating code you don't own

This extension emits deprecation warnings on code, which uses properties/functions/methods/classes which are annotated as `@deprecated`.
Expand All @@ -37,6 +45,22 @@ In case you don't own the code which you want to be considered deprecated, use [
class ThirdPartyClass {}
```

## `#[\Deprecated]` attribute (Since PHP 8.4)

PHP 8.4 introduced a native [`#[\Deprecated]`](https://wiki.php.net/rfc/deprecated_attribute) attribute that triggers a runtime deprecation notice when a symbol is called.

**This extension detects it** — no `@deprecated` PHPDoc annotation is required alongside it:

```php
#[\Deprecated('Will be removed in 2.0, use constructor injection instead.')]
public function __construct(...) {}
```

PHPStan will report call sites with the `method.deprecated` identifier, including the attribute's description string.

> [!NOTE]
> Detection of `#[\Deprecated]` is provided by this extension (`phpstan-deprecation-rules`), **not** by PHPStan core. Removing this extension silences those errors entirely.

## Custom deprecation markers

You can implement extensions to support even e.g. custom `#[MyDeprecated]` attribute. [Learn more](https://phpstan.org/developing-extensions/custom-deprecations).
Expand Down
Loading