Error Identifier: propertyTag.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 NewConfig instead */
class OldConfig
{
	public string $value;
}

/**
 * @property OldConfig $config
 */
class Foo
{
	use MagicPropertyTrait;
}

Why is it reported? #

A @property PHPDoc tag references a class that has been marked as @deprecated. Using deprecated classes in PHPDoc type declarations ties the code to types that are scheduled for removal. The deprecation notice typically indicates that a replacement exists.

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

How to fix it #

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

 <?php declare(strict_types = 1);
 
 /**
- * @property OldConfig $config
+ * @property NewConfig $config
  */
 class Foo
 {
 	use MagicPropertyTrait;
 }

If the deprecated class has no direct replacement, update the @property tag to reference the new type that serves the same role.

How to ignore this error #

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

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

Rules that report this error #

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

Edit this page on GitHub

Theme