Error Identifier: selfOut.deprecatedEnum

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 */
enum Status: string
{
	case Active = 'active';
	case Inactive = 'inactive';
}

class Builder
{
	/**
	 * @phpstan-self-out self<Status>
	 */
	public function withStatus(): void
	{
	}
}

Why is it reported? #

The @phpstan-self-out PHPDoc tag references a deprecated enum. 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 enum with its non-deprecated replacement.

 class Builder
 {
 	/**
-	 * @phpstan-self-out self<Status>
+	 * @phpstan-self-out self<NewStatus>
 	 */
 	public function withStatus(): void
 	{
 	}
 }

How to ignore this error #

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

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

Rules that report this error #

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

Edit this page on GitHub

Theme