← Back to catch.*

Error Identifier: catch.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 Use NewException instead. */
enum AppError: string implements \Throwable
{
    // ...
}

try {
    // ...
} catch (AppError $e) {
    // ...
}

Why is it reported? #

The catch clause references an enum that has been marked with a @deprecated PHPDoc tag. The enum is scheduled for removal or replacement, and any usage of it – including catching it – should be migrated to the recommended alternative.

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

How to fix it #

Replace the deprecated enum with its recommended replacement as indicated in the deprecation message:

 <?php declare(strict_types = 1);
 
 try {
     // ...
-} catch (AppError $e) {
+} catch (NewException $e) {
     // ...
 }

How to ignore this error #

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

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

Rules that report this error #

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

Edit this page on GitHub