Error Identifier: requireImplements.deprecatedClass

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 NewService instead */
class OldService
{
}

/**
 * @phpstan-require-implements OldService
 */
interface ServiceAware
{
}

Why is it reported? #

A @phpstan-require-implements PHPDoc tag references a class that has been marked as @deprecated. This means the trait or interface is requiring implementing classes to depend on a type that is scheduled for removal. The deprecation notice typically indicates a replacement exists.

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

How to fix it #

Replace the deprecated class with its recommended replacement in the @phpstan-require-implements tag:

 <?php declare(strict_types = 1);
 
 /**
- * @phpstan-require-implements OldService
+ * @phpstan-require-implements NewService
  */
 interface ServiceAware
 {
 }

If the deprecated class has no direct replacement, consider restructuring the code to remove the @phpstan-require-implements constraint, or update it to reference the new replacement type that serves the same role.

How to ignore this error #

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

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

Rules that report this error #

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

Edit this page on GitHub

Theme