← Back to assert.*

Error Identifier: assert.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 NewInterface instead */
interface OldInterface
{
	public function doSomething(): void;
}

class Foo
{
	/**
	 * @phpstan-assert OldInterface $value
	 */
	public function assertOldInterface(mixed $value): void
	{
		// ...
	}
}

Why is it reported? #

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

A @phpstan-assert PHPDoc tag references an interface that has been marked as @deprecated. Using deprecated interfaces in type assertions ties your code to interfaces that are planned for removal, making future migration harder.

In the example above, the @phpstan-assert OldInterface $value tag references the deprecated OldInterface.

How to fix it #

Replace the deprecated interface with its recommended replacement in the @phpstan-assert tag:

 <?php declare(strict_types = 1);
 
 class Foo
 {
 	/**
-	 * @phpstan-assert OldInterface $value
+	 * @phpstan-assert NewInterface $value
 	 */
-	public function assertOldInterface(mixed $value): void
+	public function assertNewInterface(mixed $value): void
 	{
 		// ...
 	}
 }

How to ignore this error #

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

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

Rules that report this error #

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

Edit this page on GitHub