Error Identifier: selfOut.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 NewTrait instead */
trait OldTrait
{
}

/**
 * @template T
 */
class Collection
{
	/**
	 * @phpstan-self-out self<OldTrait>
	 */
	public function withTrait(): void
	{
	}
}

Why is it reported? #

The @phpstan-self-out PHPDoc tag references a deprecated trait. Using deprecated symbols propagates reliance on code that is scheduled for removal or replacement.

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

How to fix it #

Replace the deprecated trait reference with its non-deprecated replacement.

 /**
- * @phpstan-self-out self<OldTrait>
+ * @phpstan-self-out self<NewTrait>
  */
 public function withTrait(): void
 {
 }

How to ignore this error #

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

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

Rules that report this error #

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

Edit this page on GitHub

Theme