Error Identifier: staticProperty.internalClass

← Back to staticProperty.*

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 */
	class InternalConfig {
		public static bool $debug = false;
	}
}

namespace App {
	function test(): bool {
		return \Vendor\InternalConfig::$debug; // error: Access to static property $debug of internal class Vendor\InternalConfig from outside its root namespace Vendor.
	}
}

Why is it reported? #

A static property is being accessed on a class that is marked as @internal. Internal classes are not meant to be used outside of their own package. Depending on their static properties creates a coupling to implementation details that can change at any time without following semantic versioning.

How to fix it #

Use the public API provided by the package instead of accessing internal class properties directly:

 namespace App {
 	function test(): bool {
-		return \Vendor\InternalConfig::$debug;
+		return \Vendor\PublicConfig::isDebug();
 	}
 }

How to ignore this error #

You can use the identifier staticProperty.internalClass to ignore this error using a comment:

// @phpstan-ignore staticProperty.internalClass
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: staticProperty.internalClass

Rules that report this error #

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