Error Identifier: assert.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 Checker
{
	/**
	 * @phpstan-assert OldLogger $value
	 */
	public function assertLogger(mixed $value): void
	{
		// ...
	}
}

Why is it reported? #

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

A @phpstan-assert PHPDoc tag references a class that has been marked as @deprecated. Deprecated classes are planned for removal in a future version, and assertions should not rely on them.

How to fix it #

Replace the deprecated class with its recommended replacement:

 <?php declare(strict_types = 1);
 
 class Checker
 {
 	/**
-	 * @phpstan-assert OldLogger $value
+	 * @phpstan-assert NewLogger $value
 	 */
 	public function assertLogger(mixed $value): void
 	{
 		// ...
 	}
 }

How to ignore this error #

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

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

Rules that report this error #

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

Edit this page on GitHub

Theme