Error Identifier: selfOut.deprecatedInterface

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);

namespace App;

/** @deprecated Use NewInterface instead */
interface OldInterface
{
}

class Foo
{
    /**
     * @phpstan-self-out self&OldInterface
     */
    public function apply(): void
    {
    }
}

Why is it reported? #

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

The @phpstan-self-out PHPDoc tag references an interface that is marked as @deprecated. The @phpstan-self-out tag is used to narrow the type of $this after a method call. Referencing a deprecated interface in this context creates a dependency on a symbol that is scheduled for removal.

How to fix it #

Replace the deprecated interface with its recommended replacement in the @phpstan-self-out tag:

 <?php declare(strict_types = 1);
 
 namespace App;

 class Foo
 {
     /**
-     * @phpstan-self-out self&OldInterface
+     * @phpstan-self-out self&NewInterface
      */
     public function apply(): void
     {
     }
 }

If the method or class is itself deprecated, the error will not be reported.

How to ignore this error #

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

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

Rules that report this error #

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

Edit this page on GitHub

Theme