Error Identifier: property.nameNotString

← Back to property.*

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

class Foo
{
	public string $bar = "hello";
}

function doFoo(Foo $foo): void
{
	$name = ["bar"];
	echo $foo->$name;
}

Why is it reported? #

When accessing an object property dynamically using the $obj->$name syntax, the $name expression must produce a string. PHP casts the name to string at runtime, so a string, an int, or an object implementing Stringable are all accepted. Values that cannot be cast to a string — such as an array or a plain object — are invalid and result in an error.

In the example above, the variable $name is an array (["bar"]), which is not a valid property name.

This check is currently part of Bleeding Edge.

How to fix it #

Ensure the dynamic property name is a string:

 function doFoo(Foo $foo): void
 {
-	$name = ["bar"];
+	$name = "bar";
 	echo $foo->$name;
 }

Or use a direct property access if the property name is known:

 function doFoo(Foo $foo): void
 {
-	$name = ["bar"];
-	echo $foo->$name;
+	echo $foo->bar;
 }

How to ignore this error #

You can use the identifier property.nameNotString to ignore this error using a comment:

// @phpstan-ignore property.nameNotString
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: property.nameNotString

Rules that report this error #

• PHPStan\Rules\Classes\ClassConstantRule [1]
• PHPStan\Rules\Methods\CallMethodsRule [1]
• PHPStan\Rules\Methods\CallStaticMethodsRule [1]
• PHPStan\Rules\Properties\AccessPropertiesInAssignRule [1]
• PHPStan\Rules\Properties\AccessPropertiesRule [1]
• PHPStan\Rules\Properties\AccessStaticPropertiesInAssignRule [1]
• PHPStan\Rules\Properties\AccessStaticPropertiesRule [1]
• PHPStan\Rules\Variables\DefinedVariableRule [1]