Error Identifier: generics.internalEnumBound

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:

/** @internal */
enum InternalStatus: string
{
    case Active = 'active';
    case Inactive = 'inactive';
}

// In your code:

/**
 * @template T of InternalStatus
 */
class StatusContainer
{
}

Why is it reported? #

A @template tag uses an internal enum as its bound type. The enum referenced in the of clause has been marked with the @internal PHPDoc tag. Internal enums are not part of the public API and are intended to be used only within the package or root namespace where they are defined. Referencing an internal enum as a template bound from outside its root namespace creates a dependency on an implementation detail that may change or be removed without notice.

How to fix it #

Replace the internal enum with a public (non-internal) enum or class in the template bound:

 <?php declare(strict_types = 1);
 
 /**
- * @template T of InternalStatus
+ * @template T of PublicStatus
  */
 class StatusContainer
 {
 }

How to ignore this error #

You can use the identifier generics.internalEnumBound to ignore this error using a comment:

// @phpstan-ignore generics.internalEnumBound
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: generics.internalEnumBound

Rules that report this error #

PHPStan\Rules\InternalTag\RestrictedInternalClassNameUsageExtension [1]

Edit this page on GitHub

Theme