Error Identifier: property.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);
/** @deprecated Use NewInterface instead */
interface OldInterface
{
public function doSomething(): void;
}
class Foo
{
public OldInterface $service;
}
Why is it reported? #
A property’s type declaration references an interface that has been marked as @deprecated. Using deprecated interfaces in property types ties the code to APIs that are scheduled for removal. The deprecation notice indicates that a replacement exists and should be used instead.
This rule is provided by the phpstan-deprecation-rules package.
How to fix it #
Replace the deprecated interface with its recommended replacement in the property type:
<?php declare(strict_types = 1);
class Foo
{
- public OldInterface $service;
+ public NewInterface $service;
}
If the replacement interface does not exist yet or the migration is ongoing, the error can be ignored on a per-line basis using a PHPStan ignore comment while the migration is being planned.
How to ignore this error #
You can use the identifier property.deprecatedInterface to ignore this error using a comment:
// @phpstan-ignore property.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: property.deprecatedInterface