← Back to sealed.*

Error Identifier: sealed.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);

namespace App;

/** @deprecated Use NewStatus instead */
enum OldStatus
{
    case Active;
    case Inactive;
}

/**
 * @phpstan-sealed OldStatus
 */
interface StatusProvider
{
}

Why is it reported? #

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

The @phpstan-sealed PHPDoc tag references an enum that is marked as @deprecated. The @phpstan-sealed tag restricts which classes or types can be part of a sealed type hierarchy. Referencing a deprecated enum in this tag creates a dependency on a symbol that is scheduled for removal.

How to fix it #

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

 <?php declare(strict_types = 1);
 
 namespace App;

 /**
- * @phpstan-sealed OldStatus
+ * @phpstan-sealed NewStatus
  */
 interface StatusProvider
 {
 }

If the containing declaration is itself deprecated, the error will not be reported.

How to ignore this error #

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

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

Rules that report this error #

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

Edit this page on GitHub