← Back to instanceof.*

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

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

class NewLogger {}

function doFoo(object $obj): void
{
	if ($obj instanceof OldLogger) { // ERROR: Usage of deprecated class OldLogger in instanceof.
		// ...
	}
}

Why is it reported? #

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

The class used in the instanceof check has been marked as deprecated with the @deprecated PHPDoc tag. Using deprecated classes should be avoided because they may be removed in a future version of the library or application. The deprecation notice typically suggests a replacement class to use instead.

How to fix it #

Replace the deprecated class with its suggested replacement:

 <?php declare(strict_types = 1);
 
 function doFoo(object $obj): void
 {
-	if ($obj instanceof OldLogger) {
+	if ($obj instanceof NewLogger) {
 		// ...
 	}
 }

How to ignore this error #

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

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

Rules that report this error #

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

Edit this page on GitHub