← Back to catch.*

Error Identifier: catch.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 NewException instead */
trait OldExceptionTrait
{
}

class MyException extends \Exception
{
	use OldExceptionTrait;
}

try {
	// ...
} catch (MyException $e) {
	// The catch block itself is fine, but the trait is deprecated
}

Why is it reported? #

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

The catch block references a type that uses a deprecated trait. The trait has been marked with a @deprecated PHPDoc tag, indicating it is scheduled for removal or replacement. Any usage of deprecated types should be migrated to the recommended alternative.

How to fix it #

Replace the deprecated trait with its recommended replacement:

 <?php declare(strict_types = 1);
 
 class MyException extends \Exception
 {
-	use OldExceptionTrait;
+	use NewExceptionTrait;
 }

Or if the deprecation affects the caught class directly, catch the replacement class instead:

 try {
 	// ...
-} catch (MyException $e) {
+} catch (NewException $e) {
 	// ...
 }

How to ignore this error #

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

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

Rules that report this error #

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

Edit this page on GitHub