Error Identifier: varTag.deprecatedInterface

← Back to varTag.*

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 NewLogger instead */
interface OldLogger
{
}

/** @return mixed */
function getLogger()
{
	return null;
}

function doFoo(): void
{
	/** @var OldLogger $x */
	$x = getLogger();
}

Why is it reported? #

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

An inline @var PHPDoc tag references an interface that has been marked as @deprecated. Deprecated interfaces are planned for removal in a future version, and type annotations should not rely on them.

How to fix it #

Update the @var tag to reference the replacement interface:

-	/** @var OldLogger $x */
+	/** @var NewLogger $x */
 	$x = getLogger();

How to ignore this error #

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

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

Rules that report this error #

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