Error Identifier: classConstant.internalTrait

← Back to classConstant.*

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 const VALUE = 42;
	}
}

namespace App {
	function test(): int {
		return \Vendor\InternalTrait::VALUE; // error: Access to constant VALUE of internal trait Vendor\InternalTrait from outside its root namespace Vendor.
	}
}

Why is it reported? #

The constant is defined on a trait that is marked as @internal. Internal types are not part of the package’s public API and may change or be removed without notice. Accessing constants on internal traits from outside their package creates a fragile dependency.

How to fix it #

Use a public (non-internal) constant or API instead. If no public alternative exists, consider reaching out to the package maintainers to request a public API for your use case.

 namespace App {
 	function test(): int {
-		return \Vendor\InternalTrait::VALUE;
+		return \Vendor\PublicClass::VALUE;
 	}
 }

How to ignore this error #

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

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

Rules that report this error #

• PHPStan\Rules\InternalTag\RestrictedInternalClassConstantUsageExtension [1] [2]
• PHPStan\Rules\InternalTag\RestrictedInternalClassNameUsageExtension [1]