← Back to enum.*

Error Identifier: enum.implementsDeprecatedInterface

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 NewInterface instead */
interface OldInterface
{
	public function doSomething(): void;
}

enum Status: string implements OldInterface
{
	case Active = 'active';
	case Inactive = 'inactive';

	public function doSomething(): void
	{
	}
}

Why is it reported? #

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

An enum implements an interface that has been marked as @deprecated. Implementing deprecated interfaces ties the enum to a contract that is planned for removal.

In the example above, enum Status implements OldInterface, which is deprecated.

How to fix it #

Replace the deprecated interface with its recommended replacement:

 <?php declare(strict_types = 1);
 
-enum Status: string implements OldInterface
+enum Status: string implements NewInterface
 {
 	case Active = 'active';
 	case Inactive = 'inactive';

 	public function doSomething(): void
 	{
 	}
 }

How to ignore this error #

You can use the identifier enum.implementsDeprecatedInterface to ignore this error using a comment:

// @phpstan-ignore enum.implementsDeprecatedInterface
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: enum.implementsDeprecatedInterface

Rules that report this error #

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

Edit this page on GitHub