Error Identifier: propertyTag.deprecatedTrait

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 SomethingElse instead */
trait HelperTrait
{
}

/**
 * @property HelperTrait $helper // ERROR: PHPDoc tag @property references deprecated trait HelperTrait.
 */
class Foo
{
}

Why is it reported? #

The @property PHPDoc tag references a trait that has been marked as @deprecated. Traits are not valid types in PHP, and using a deprecated trait as a type in a @property tag compounds two issues: the type is not valid, and the referenced trait is deprecated.

This rule is provided by the phpstan/phpstan-deprecation-rules package.

How to fix it #

Replace the deprecated trait reference in the @property tag with a valid, non-deprecated type such as an interface or class:

 <?php declare(strict_types = 1);
 
 /**
- * @property HelperTrait $helper
+ * @property HelperInterface $helper
  */
 class Foo
 {
 }

How to ignore this error #

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

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

Rules that report this error #

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

Edit this page on GitHub

Theme