Error Identifier: requireImplements.deprecatedInterface

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 */
interface OldInterface {}

/**
 * @phpstan-require-implements OldInterface
 */
trait MyTrait {}

Why is it reported? #

The @phpstan-require-implements PHPDoc tag references an interface that has been marked as @deprecated. Using deprecated interfaces in new constraints means your code is relying on functionality that is planned for removal in a future version.

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

How to fix it #

Replace the deprecated interface with its recommended replacement:

 <?php declare(strict_types = 1);
 
 /**
- * @phpstan-require-implements OldInterface
+ * @phpstan-require-implements NewInterface
  */
 trait MyTrait {}

If no replacement exists, remove the @phpstan-require-implements tag if the constraint is no longer needed:

 <?php declare(strict_types = 1);
 
-/**
- * @phpstan-require-implements OldInterface
- */
 trait MyTrait {}

How to ignore this error #

You can use the identifier requireImplements.deprecatedInterface to ignore this error using a comment:

// @phpstan-ignore requireImplements.deprecatedInterface
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: requireImplements.deprecatedInterface

Rules that report this error #

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

Edit this page on GitHub

Theme