Error Identifier: requireExtends.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 */
enum Suit: string
{
	case Hearts = 'hearts';
	case Diamonds = 'diamonds';
}

/**
 * @phpstan-require-extends Suit
 */
interface SuitAware
{
}

Why is it reported? #

The @phpstan-require-extends PHPDoc tag references a deprecated enum. Using deprecated symbols propagates reliance on code that is scheduled for removal or replacement.

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

How to fix it #

Replace the deprecated enum with its non-deprecated replacement.

-/** @deprecated */
-enum Suit: string
+enum CardSuit: string
 {
 	case Hearts = 'hearts';
 	case Diamonds = 'diamonds';
 }

 /**
- * @phpstan-require-extends Suit
+ * @phpstan-require-extends CardSuit
  */
 interface SuitAware
 {
 }

How to ignore this error #

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

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

Rules that report this error #

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

Edit this page on GitHub

Theme