← Back to return.*

Error Identifier: return.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 NewHelper instead */
trait OldHelper
{
}

class Foo
{
    public function create(): OldHelper
    {
        // ...
    }
}

Why is it reported? #

This error is reported by phpstan/phpstan-deprecation-rules.

The return type of a function or method references a trait marked with a @deprecated PHPDoc tag. Deprecated traits are scheduled for removal, and return types referencing them should be updated to use the recommended replacement.

How to fix it #

Replace the deprecated trait with its recommended replacement in the return type:

 <?php declare(strict_types = 1);
 
 class Foo
 {
-    public function create(): OldHelper
+    public function create(): NewHelper
     {
         // ...
     }
 }

How to ignore this error #

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

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

Rules that report this error #

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

Edit this page on GitHub