Error Identifier: parameter.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.

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

Code example #

<?php declare(strict_types = 1);

/** @deprecated Use NewLogger instead */
class OldLogger
{
}

function process(OldLogger $logger): void
{
}

Why is it reported? #

A function or method parameter uses a deprecated class as its type declaration. The class has been marked with a @deprecated PHPDoc tag, indicating it should no longer be used. Using a deprecated class in a parameter type ties new code to an obsolete API.

How to fix it #

Replace the deprecated class with its recommended replacement in the parameter type declaration.

 <?php declare(strict_types = 1);
 
-function process(OldLogger $logger): void
+function process(NewLogger $logger): void
 {
 }

How to ignore this error #

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

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

Rules that report this error #

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

Edit this page on GitHub

Theme