Error Identifier: method.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 NewStatus instead */
enum OldStatus: string
{
case Active = 'active';
case Inactive = 'inactive';
public function label(): string
{
return $this->value;
}
}
function doFoo(OldStatus $status): void
{
$status->label(); // ERROR: Call to method label() of deprecated enum OldStatus.
}
Why is it reported? #
This error is reported by phpstan/phpstan-deprecation-rules.
A method is being called on an instance of an enum that has been marked as @deprecated. Even though the method itself is not deprecated, the entire enum is deprecated, which means all usage of the enum – including calling its methods – should be replaced with the suggested alternative.
How to fix it #
Replace the usage of the deprecated enum with its recommended replacement:
<?php declare(strict_types = 1);
-function doFoo(OldStatus $status): void
+function doFoo(NewStatus $status): void
{
$status->label();
}
How to ignore this error #
You can use the identifier method.deprecatedEnum to ignore this error using a comment:
// @phpstan-ignore method.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: method.deprecatedEnum