Error Identifier: varTag.deprecatedEnum

Every error reported by PHPStan has an error identifier. Here’s a list of all error identifiers. In PHPStan Pro you can see the error identifier next to each error and filter errors by their identifiers.

This error is reported by phpstan/phpstan-deprecation-rules.

Code example #

<?php declare(strict_types = 1);

/**
 * @deprecated Use NewStatus instead
 */
enum OldStatus: string
{
	case Active = 'active';
}

/** @var OldStatus $status */
$status = getStatus();

Why is it reported? #

The @var PHPDoc tag references an enum that is marked as @deprecated. Using deprecated symbols in PHPDoc tags maintains a dependency on code that is scheduled for removal and should be migrated to the replacement.

How to fix it #

Update the @var tag to reference the non-deprecated replacement enum.

 <?php declare(strict_types = 1);
 
-/** @var OldStatus $status */
+/** @var NewStatus $status */
 $status = getStatus();

How to ignore this error #

You can use the identifier varTag.deprecatedEnum to ignore this error using a comment:

// @phpstan-ignore varTag.deprecatedEnum
codeThatProducesTheError();

You can also use only the identifier key to ignore all errors of the same type in your configuration file in the ignoreErrors parameter:

parameters:
	ignoreErrors:
		-
			identifier: varTag.deprecatedEnum

Rules that report this error #

PHPStan\Rules\Deprecations\RestrictedDeprecatedClassNameUsageExtension [1] phpstan/phpstan-deprecation-rules

Edit this page on GitHub

Theme