Error Identifier: typeAlias.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 NewHandler instead */
interface OldHandler
{
}

/**
 * @phpstan-type HandlerType OldHandler
 */
class Factory
{
}

Why is it reported? #

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

A type alias defined with @phpstan-type references a deprecated interface. Deprecated interfaces are scheduled for removal or replacement. Using them in type aliases propagates the dependency on a deprecated API to all code that uses the alias.

How to fix it #

Update the type alias to reference the replacement interface:

 /**
- * @phpstan-type HandlerType OldHandler
+ * @phpstan-type HandlerType NewHandler
  */
 class Factory
 {
 }

If the calling code is itself deprecated, the error will not be reported. Mark the class as deprecated if it is part of a deprecation migration:

+/** @deprecated */
 /**
  * @phpstan-type HandlerType OldHandler
  */
 class Factory
 {
 }

How to ignore this error #

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

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

Rules that report this error #

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

Edit this page on GitHub

Theme