Error Identifier: assert.internalInterface

← Back to assert.*

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 Logger {
		public function log(string $message): void;
	}
}

namespace App {
	class Checker {
		/**
		 * @phpstan-assert \Vendor\Logger $value
		 * @param mixed $value
		 */
		public function assertLogger($value): void
		{
		}
	}
}

Why is it reported? #

A @phpstan-assert PHPDoc tag references an interface that is marked as @internal. Internal types are not meant to be used outside of the package or namespace where they are defined. Depending on internal types in your assertions creates a fragile dependency on implementation details that can change without notice.

How to fix it #

Use a public (non-internal) type in the @phpstan-assert tag instead:

 class Checker
 {
 	/**
-	 * @phpstan-assert \Vendor\Logger $value
+	 * @phpstan-assert \Psr\Log\LoggerInterface $value
 	 * @param mixed $value
 	 */
 	public function assertLogger($value): void
 	{
 	}
 }

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 assert.internalInterface to ignore this error using a comment:

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

Rules that report this error #

• PHPStan\Rules\InternalTag\RestrictedInternalClassNameUsageExtension [1]