Error Identifier: staticProperty.internalTrait

← 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 */
	trait InternalTrait {
		public static string $debug = 'off';
	}
}

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

Why is it reported? #

A static property is being accessed on a trait that is marked as @internal. Internal traits are not part of the public API of the package that defines them. They may change or be removed in any version without notice. Accessing static properties on internal traits creates a dependency on implementation details that should not be relied upon.

How to fix it #

Use the public API of the package instead of accessing static properties on internal traits:

 namespace App {
 	function test(): string {
-		return \Vendor\InternalTrait::$debug;
+		return \Vendor\PublicConfig::getDebugMode();
 	}
 }

If the trait is internal to the same package, the error will not be reported. The @internal restriction only applies to cross-package usage.

How to ignore this error #

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

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

Rules that report this error #

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