Error Identifier: generics.internalInterfaceDefault

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 */
interface InternalProcessor
{
}

// In your code:

/**
 * @template T = InternalProcessor
 */
class Pipeline
{
}

Why is it reported? #

A @template tag uses an internal interface as its default type. The interface referenced in the default value of the template parameter has been marked with the @internal PHPDoc tag. Internal interfaces 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 interface as a template default 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 interface with a public (non-internal) interface in the template default:

 <?php declare(strict_types = 1);
 
 /**
- * @template T = InternalProcessor
+ * @template T = PublicProcessor
  */
 class Pipeline
 {
 }

How to ignore this error #

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

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

Rules that report this error #

PHPStan\Rules\InternalTag\RestrictedInternalClassNameUsageExtension [1]

Edit this page on GitHub

Theme