Error Identifier: classConstant.internal

← 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 {
	class Config {
		/** @internal */
		public const DEBUG_MODE = true;

		public const VERSION = '1.0';
	}
}

namespace App {
	function test(): bool {
		return \Vendor\Config::DEBUG_MODE; // error: Access to internal constant Vendor\Config::DEBUG_MODE from outside its root namespace Vendor.
	}
}

Why is it reported? #

The class constant is marked as @internal and is being accessed from outside the package where it is defined. Internal constants are not part of the package’s public API and may change or be removed without notice.

How to fix it #

Use a public (non-internal) constant or API instead:

 namespace App {
 	function test(): string {
-		return \Vendor\Config::DEBUG_MODE;
+		return \Vendor\Config::VERSION;
 	}
 }

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

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

Rules that report this error #

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