Error Identifier: parameter.internalTrait

← Back to parameter.*

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 */
	trait InternalTrait {
		public function doSomething(): void {}
	}

	class Foo {
		use InternalTrait;
	}
}

namespace App {
	/** @param \Vendor\InternalTrait $x */
	function process($x): void {}
}

Why is it reported? #

A parameter type declaration references a trait 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 parameter declarations creates a fragile dependency on implementation details that can change without notice.

Traits should generally not be used as types in parameter declarations, since PHP does not support using traits as type hints.

How to fix it #

Use a public (non-internal) interface or class as the parameter type instead:

 namespace App {
-	/** @param \Vendor\InternalTrait $x */
+	/** @param \Vendor\PublicInterface $x */
 	function process($x): void {}
 }

How to ignore this error #

You can use the identifier parameter.internalTrait to ignore this error using a comment:

// @phpstan-ignore parameter.internalTrait
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: parameter.internalTrait

Rules that report this error #

• PHPStan\Rules\InternalTag\RestrictedInternalClassNameUsageExtension [1]