Error Identifier: varTag.misplaced

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

/** @var int $x */
class Foo
{
}

Why is it reported? #

The @var PHPDoc tag is placed above a class, interface, enum, function, or method definition where it has no effect. The @var tag is designed to annotate the type of a variable in a local scope, typically above a variable assignment or a foreach loop. Placing it above a structural element like a class or method does nothing because there is no variable to annotate.

Other locations where this is reported:

<?php declare(strict_types = 1);

/** @var string $name */
function doFoo(): void
{
    // @var tag above a function has no effect
}

class Bar
{
    /** @var int $count */
    public function doBar(): void
    {
        // @var tag above a method has no effect
    }
}

How to fix it #

Move the @var tag to the correct location, directly above a variable assignment:

 <?php declare(strict_types = 1);
 
-/** @var int $x */
 class Foo
 {
+    public function doFoo(): void
+    {
+        /** @var int $x */
+        $x = $this->getValue();
+    }
 }

If the intent was to document a class property, use the @var tag on the property declaration itself:

 <?php declare(strict_types = 1);
 
-/** @var int $x */
 class Foo
 {
+    /** @var int */
+    public $x;
 }

Or use a native PHP type declaration:

 <?php declare(strict_types = 1);
 
-/** @var int $x */
 class Foo
 {
+    public int $x;
 }

How to ignore this error #

You can use the identifier varTag.misplaced to ignore this error using a comment:

// @phpstan-ignore varTag.misplaced
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: varTag.misplaced

Rules that report this error #

PHPStan\Rules\PhpDoc\WrongVariableNameInVarTagRule [1]

Edit this page on GitHub

Theme