← Back to instanceof.*

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

function checkStatus(object $obj): void
{
    if ($obj instanceof OldStatus) { // error
        // ...
    }
}

Why is it reported? #

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

The instanceof check references an enum that has been marked with the @deprecated PHPDoc tag. Deprecated enums are scheduled for removal or replacement, and any usage – including in instanceof checks – should be migrated to the recommended alternative. When the deprecated enum is removed, this instanceof check will stop working correctly.

How to fix it #

Replace the deprecated enum with its suggested replacement:

 <?php declare(strict_types = 1);
 
 function checkStatus(object $obj): void
 {
-    if ($obj instanceof OldStatus) {
+    if ($obj instanceof NewStatus) {
         // ...
     }
 }

How to ignore this error #

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

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

Rules that report this error #

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

Edit this page on GitHub