https://github.com/phpstan/phpstan-deprecation-rules

PHPStan rules for detecting usage of deprecated classes, methods, properties, constants and traits.
https://github.com/phpstan/phpstan-deprecation-rules

deprecations php php7 phpstan static-analysis static-code-analysis

Last synced: about 2 months ago
JSON representation

PHPStan rules for detecting usage of deprecated classes, methods, properties, constants and traits.

• Host: GitHub
• URL: https://github.com/phpstan/phpstan-deprecation-rules
• Owner: phpstan
• Created: 2018-06-24T11:28:18.000Z (about 6 years ago)
• Default Branch: 1.2.x
• Last Pushed: 2024-03-13T08:03:21.000Z (6 months ago)
• Last Synced: 2024-04-14T14:13:01.655Z (5 months ago)
• Topics: deprecations, php, php7, phpstan, static-analysis, static-code-analysis
• Language: PHP
• Homepage:
• Size: 192 KB
• Stars: 351
• Watchers: 5
• Forks: 17
• Open Issues: 14
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Rules for detecting usage of deprecated classes, methods, properties, constants and traits.

[![Build](https://github.com/phpstan/phpstan-deprecation-rules/workflows/Build/badge.svg)](https://github.com/phpstan/phpstan-deprecation-rules/actions)

[![Latest Stable Version](https://poser.pugx.org/phpstan/phpstan-deprecation-rules/v/stable)](https://packagist.org/packages/phpstan/phpstan-deprecation-rules)

[![License](https://poser.pugx.org/phpstan/phpstan-deprecation-rules/license)](https://packagist.org/packages/phpstan/phpstan-deprecation-rules)

* [PHPStan](https://phpstan.org/)

## Installation

To use this extension, require it in [Composer](https://getcomposer.org/):

```

composer require --dev phpstan/phpstan-deprecation-rules

```

If you also install [phpstan/extension-installer](https://github.com/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](https://phpstan.org/user-guide/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:

```php

/** @deprecated */

function doFoo(): void

{

    // not reported:

    anotherDeprecatedFunction();

}

```

If you have [a different way](https://github.com/phpstan/phpstan-deprecation-rules/issues/64) 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`](https://github.com/phpstan/phpstan-deprecation-rules/blob/1.1.x/src/Rules/Deprecations/DeprecatedScopeResolver.php) interface.

For example if you mark your PHPUnit tests that test deprecated code with `@group legacy`, you can implement the extension this way:

```php

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](https://phpstan.org/config-reference):

```neon

services:

	-

		class: GroupLegacyScopeResolver

		tags:

			- phpstan.deprecations.deprecatedScopeResolver

```

[Learn more about Scope](https://phpstan.org/developing-extensions/scope), a core concept for implementing custom PHPStan extensions.