Error Identifier: typeAlias.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);

namespace App;

/** @deprecated Use NewService instead */
class OldService
{
}

/**
 * @phpstan-type ServiceType OldService
 */
class ServiceFactory
{
}

Why is it reported? #

This error is reported by the phpstan/phpstan-deprecation-rules package.

A PHPStan type alias (defined with @phpstan-type or referenced via @phpstan-import-type) references a class that is marked as @deprecated. Using a deprecated class in a type alias creates a dependency on a symbol that is scheduled for removal.

How to fix it #

Replace the deprecated class in the type alias with its recommended replacement:

 <?php declare(strict_types = 1);
 
 namespace App;

 /**
- * @phpstan-type ServiceType OldService
+ * @phpstan-type ServiceType NewService
  */
 class ServiceFactory
 {
 }

If the class containing the type alias is itself deprecated, the error will not be reported.

How to ignore this error #

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

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

Rules that report this error #

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

Edit this page on GitHub

Theme