Error Identifier: requireImplements.internalInterface

← Back to requireImplements.*

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

namespace Vendor {
	/** @internal */
	interface InternalInterface {}
}

namespace App {
	/**
	 * @phpstan-require-implements \Vendor\InternalInterface
	 */
	trait MyTrait {}
}

Why is it reported? #

The @phpstan-require-implements PHPDoc tag references an interface that is marked as @internal. Internal interfaces are not part of the public API of their package and may change or be removed without notice. Depending on an internal interface in a @phpstan-require-implements constraint creates a fragile dependency on implementation details.

How to fix it #

Use a public (non-internal) interface in the @phpstan-require-implements tag instead:

 /**
- * @phpstan-require-implements \Vendor\InternalInterface
+ * @phpstan-require-implements \Vendor\PublicInterface
  */
 trait MyTrait {}

If no public alternative exists, consider reaching out to the package maintainers to request a public API for your use case.

How to ignore this error #

You can use the identifier requireImplements.internalInterface to ignore this error using a comment:

// @phpstan-ignore requireImplements.internalInterface
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: requireImplements.internalInterface

Rules that report this error #

• PHPStan\Rules\InternalTag\RestrictedInternalClassNameUsageExtension [1]