Error Identifier: assert.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';
}

class Foo
{
    /**
     * @phpstan-assert OldStatus $value
     */
    public function assertStatus(mixed $value): void
    {
        // ...
    }
}

Why is it reported? #

The @phpstan-assert PHPDoc tag references an enum that has been marked with a @deprecated PHPDoc tag. The enum is scheduled for removal or replacement, and any usage of it – including in assertion type annotations – should be migrated to the recommended alternative.

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

How to fix it #

Replace the deprecated enum with its recommended replacement in the @phpstan-assert tag:

 <?php declare(strict_types = 1);
 
 class Foo
 {
     /**
-     * @phpstan-assert OldStatus $value
+     * @phpstan-assert NewStatus $value
      */
     public function assertStatus(mixed $value): void
     {
         // ...
     }
 }

How to ignore this error #

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

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

Rules that report this error #

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

Edit this page on GitHub

Theme