Error Identifier: propertyTag.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.

Code example #

<?php declare(strict_types = 1);

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

/**
 * @property OldStatus $status
 */
class Foo
{
	use MagicPropertyTrait;
}

Why is it reported? #

A @property PHPDoc tag references an enum that has been marked as @deprecated. Using deprecated enums in PHPDoc type declarations ties the code to types that are scheduled for removal. The deprecation notice typically indicates that a replacement exists.

This rule is provided by the phpstan-deprecation-rules package.

How to fix it #

Replace the deprecated enum with its recommended replacement in the @property tag:

 <?php declare(strict_types = 1);
 
 /**
- * @property OldStatus $status
+ * @property NewStatus $status
  */
 class Foo
 {
 	use MagicPropertyTrait;
 }

How to ignore this error #

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

// @phpstan-ignore propertyTag.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: propertyTag.deprecatedEnum

Rules that report this error #

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

Edit this page on GitHub

Theme