← Back to property.*

Error Identifier: property.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 Status
{
	case Active;
	case Inactive;
}

class Order
{
	public Status $status;
}

Why is it reported? #

The property’s native type declaration references a deprecated enum. Continuing to use deprecated enums couples code to APIs that are planned for removal.

This also triggers when accessing a property (including static properties) of a deprecated enum.

How to fix it #

Replace the deprecated enum with its recommended replacement:

 class Order
 {
-	public Status $status;
+	public NewStatus $status;
 }

How to ignore this error #

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

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

Rules that report this error #

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

Edit this page on GitHub