Error Identifier: class.implementsInternalEnum

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-library:

namespace SomeLibrary;

/** @internal */
enum Status
{
	case Active;
	case Inactive;
}

<?php declare(strict_types = 1);

// In your code:

namespace App;

use SomeLibrary\Status;

class Foo implements Status
{
}

Why is it reported? #

A class implements an enum that is marked as @internal. Internal types are not meant to be used outside the package or namespace where they are defined. While enums cannot actually be implemented by classes in PHP, PHPStan reports this as an internal usage violation because the reference to the internal type is itself problematic.

How to fix it #

Use a public (non-internal) interface or class instead:

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

-use SomeLibrary\Status;
+use SomeLibrary\StatusInterface;

-class Foo implements Status
+class Foo implements StatusInterface
 {
 }

If the library provides a public interface for this purpose, use that instead.

How to ignore this error #

You can use the identifier class.implementsInternalEnum to ignore this error using a comment:

// @phpstan-ignore class.implementsInternalEnum
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: class.implementsInternalEnum

Rules that report this error #

PHPStan\Rules\InternalTag\RestrictedInternalClassNameUsageExtension [1]

Edit this page on GitHub

Theme