Error Identifier: methodTag.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 Use NewInterface instead */
interface OldInterface
{
}

/**
 * @method OldInterface getInterface()
 */
class Foo
{
}

Why is it reported? #

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

A @method PHPDoc tag references a deprecated interface in its type declaration. Deprecated types are planned for removal in a future version, and PHPDoc annotations should not rely on them.

How to fix it #

Update the @method tag to use the replacement type:

 <?php declare(strict_types = 1);
 
 /**
- * @method OldInterface getInterface()
+ * @method NewInterface getInterface()
  */
 class Foo
 {
 }

How to ignore this error #

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

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

Rules that report this error #

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

Edit this page on GitHub

Theme