← Back to phpstan.*

Error Identifier: phpstan.dumpPhpDocType

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);

/**
 * @template T
 * @param T $value
 * @return T
 */
function identity($value)
{
	\PHPStan\dumpPhpDocType($value);

	return $value;
}

Why is it reported? #

The PHPStan\dumpPhpDocType() function is a debugging tool built into PHPStan that outputs the PHPDoc representation of the type of each argument it receives. When called, PHPStan reports the dumped type as an error so the developer can inspect how PHPStan represents the type in PHPDoc notation.

In the example above, calling \PHPStan\dumpPhpDocType($value) inside a generic function would produce: Dumped type: T.

How to fix it #

Remove the \PHPStan\dumpPhpDocType() call once the type has been inspected. It is intended only as a temporary debugging aid during development and should not remain in production code:

 <?php declare(strict_types = 1);
 
 /**
  * @template T
  * @param T $value
  * @return T
  */
 function identity($value)
 {
-	\PHPStan\dumpPhpDocType($value);
-
 	return $value;
 }

Non-ignorable error #

This error cannot be ignored using @phpstan-ignore or the ignoreErrors configuration. Non-ignorable errors indicate code that would cause a crash or a fatal error at runtime, or a fundamental problem in the analysed code that must be addressed.

Rules that report this error #

• PHPStan\Rules\Debug\DumpPhpDocTypeRule [1]

Edit this page on GitHub