Error Identifier: enum.implementsInternalTrait

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

// In package vendor/some-package:
namespace SomePackage;

/** @internal */
trait InternalHelper {}

<?php declare(strict_types = 1);

// In your code:
use SomePackage\InternalHelper;

enum MyEnum implements InternalHelper
{
	case Foo;
}

Why is it reported? #

The enum references an internal trait in its implements clause. The trait is marked with @internal, meaning it is not meant to be used outside the package that defines it. Internal types can change or be removed without notice in future versions.

Additionally, using a trait in an implements clause is invalid PHP. Traits should be used with the use keyword inside the enum body, not in the implements clause.

How to fix it #

If an interface is intended, use the correct non-internal interface:

-enum MyEnum implements InternalHelper
+enum MyEnum implements PublicInterface
 {
 	case Foo;
 }

If a trait is intended, move it to a use statement inside the enum body and ensure the trait is not internal:

-enum MyEnum implements InternalHelper
+enum MyEnum
 {
+	use SomePublicTrait;
+
 	case Foo;
 }

How to ignore this error #

You can use the identifier enum.implementsInternalTrait to ignore this error using a comment:

// @phpstan-ignore enum.implementsInternalTrait
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: enum.implementsInternalTrait

Rules that report this error #

PHPStan\Rules\InternalTag\RestrictedInternalClassNameUsageExtension [1]

Edit this page on GitHub

Theme