Error Identifier: propertyTag.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;
}

/**
 * @property OldInterface $handler
 */
class Foo
{
	// magic property using deprecated interface
}

Why is it reported? #

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

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

How to fix it #

Replace the deprecated interface with its recommended replacement in the @property tag:

 <?php declare(strict_types = 1);
 
 /**
- * @property OldInterface $handler
+ * @property NewInterface $handler
  */
 class Foo
 {
 	// magic property using current interface
 }

How to ignore this error #

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

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

Rules that report this error #

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

Edit this page on GitHub

Theme