Error Identifier: selfOut.internalClass

← Back to selfOut.*

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 InternalType {}
}

namespace App {
	class Builder {
		/**
		 * @phpstan-self-out \Vendor\InternalType
		 */
		public function build(): void {}
	}
}

Why is it reported? #

The @phpstan-self-out PHPDoc tag references a class that is marked as @internal. Internal classes are not part of the public API of their package and may change or be removed at any time. Referencing them in a @phpstan-self-out tag creates a dependency on an internal implementation detail that may break without notice.

How to fix it #

Replace the internal class with a public type:

 class Builder {
 	/**
-	 * @phpstan-self-out \Vendor\InternalType
+	 * @phpstan-self-out \Vendor\PublicType
 	 */
 	public function build(): void {}
 }

If the class 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 selfOut.internalClass to ignore this error using a comment:

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

Rules that report this error #

• PHPStan\Rules\InternalTag\RestrictedInternalClassNameUsageExtension [1]