Describe array shape key in quotes unless valid identifier

vojtech-dobes · vojtech-dobes · commit 4418d52b0e5b · 2025-06-23T17:25:32.000+02:00
diff --git a/src/Type/Constant/ConstantArrayType.php b/src/Type/Constant/ConstantArrayType.php
@@ -1348,6 +1348,8 @@ public function describe(VerbosityLevel $level): string
 						$keyDescription = sprintf('\'%s\'', $keyDescription);
 					} elseif (str_contains($keyDescription, '\'')) {
 						$keyDescription = sprintf('"%s"', $keyDescription);
+					} elseif (!self::isValidIdentifier($keyDescription)) {
+						$keyDescription = sprintf('\'%s\'', $keyDescription);
 					}
 				}
 
diff --git a/tests/PHPStan/Analyser/LegacyNodeScopeResolverTest.php b/tests/PHPStan/Analyser/LegacyNodeScopeResolverTest.php
@@ -1538,7 +1538,7 @@ public static function dataCasts(): array
 				'(float) $str',
 			],
 			[
-				"array{\0TypesNamespaceCasts\\Foo\0foo: TypesNamespaceCasts\\Foo, \0TypesNamespaceCasts\\Foo\0int: int, \0*\0protectedInt: int, publicInt: int, \0TypesNamespaceCasts\\Bar\0barProperty: TypesNamespaceCasts\\Bar}",
+				"array{'\0TypesNamespaceCasts\\Foo\0foo': TypesNamespaceCasts\\Foo, '\0TypesNamespaceCasts\\Foo\0int': int, '\0*\0protectedInt': int, publicInt: int, '\0TypesNamespaceCasts\\Bar\0barProperty': TypesNamespaceCasts\\Bar}",
 				'(array) $foo',
 			],
 			[
diff --git a/tests/PHPStan/Analyser/nsrt/array-combine-php8.php b/tests/PHPStan/Analyser/nsrt/array-combine-php8.php
@@ -33,15 +33,15 @@ function withBoolKey(): void
 	$c = [false, 'red', 'yellow'];
 	$d = ['avocado', 'apple', 'banana'];
 
-	assertType("array{: 'avocado', red: 'apple', yellow: 'banana'}", array_combine($c, $d));
+	assertType("array{'': 'avocado', red: 'apple', yellow: 'banana'}", array_combine($c, $d));
 }
 
 function withFloatKey(): void
 {
 	$a = [1.5, 'red', 'yellow'];
 	$b = ['avocado', 'apple', 'banana'];
 
-	assertType("array{1.5: 'avocado', red: 'apple', yellow: 'banana'}", array_combine($a, $b));
+	assertType("array{'1.5': 'avocado', red: 'apple', yellow: 'banana'}", array_combine($a, $b));
 }
 
 function withIntegerKey(): void
diff --git a/tests/PHPStan/Analyser/nsrt/array-fill-keys.php b/tests/PHPStan/Analyser/nsrt/array-fill-keys.php
@@ -26,12 +26,12 @@ class Baz {}
 function withBoolKey() : array
 {
 	assertType("array{1: 'b'}", array_fill_keys([true], 'b'));
-	assertType("array{: 'b'}", array_fill_keys([false], 'b'));
+	assertType("array{'': 'b'}", array_fill_keys([false], 'b'));
 }
 
 function withFloatKey() : array
 {
-	assertType("array{1.5: 'b'}", array_fill_keys([1.5], 'b'));
+	assertType("array{'1.5': 'b'}", array_fill_keys([1.5], 'b'));
 }
 
 function withIntegerKey() : array
diff --git a/tests/PHPStan/Analyser/nsrt/array-shapes-keys-strings.php b/tests/PHPStan/Analyser/nsrt/array-shapes-keys-strings.php
@@ -17,8 +17,8 @@ class Foo
 	 */
 	public function doFoo(array $slash, array $dollar): void
 	{
-		assertType('array{namespace/key: string}', $slash);
-		assertType('array<int, array{$ref: string}>', $dollar);
+		assertType("array{'namespace/key': string}", $slash);
+		assertType('array<int, array{\'$ref\': string}>', $dollar);
 	}
 
 }
diff --git a/tests/PHPStan/Analyser/nsrt/bug-11716.php b/tests/PHPStan/Analyser/nsrt/bug-11716.php
@@ -13,7 +13,7 @@ public function parse(string $glue): string
 	{
 		$seenGlues = ['|' => false, '&' => false];
 
-		assertType("array{|: false, &: false}", $seenGlues);
+		assertType("array{'|': false, '&': false}", $seenGlues);
 
 		if ($glue !== '') {
 			assertType('non-empty-string', $glue);
@@ -22,13 +22,13 @@ public function parse(string $glue): string
 			$seenGlues[$glue] = true;
 
 			assertType("'&'|'|'", $glue);
-			assertType('array{|: bool, &: bool}', $seenGlues);
+			assertType("array{'|': bool, '&': bool}", $seenGlues);
 		} else {
 			assertType("''", $glue);
 		}
 
 		assertType("''|'&'|'|'", $glue);
-		assertType("array{|: bool, &: bool}", $seenGlues);
+		assertType("array{'|': bool, '&': bool}", $seenGlues);
 
 		return array_key_first($seenGlues);
 	}
diff --git a/tests/PHPStan/Analyser/nsrt/bug-5219.php b/tests/PHPStan/Analyser/nsrt/bug-5219.php
@@ -20,6 +20,6 @@ protected function bar(string $message): void
 		$header = sprintf('%s-%s', '', '');
 
 		assertType('\'-\'', $header);
-		assertType('array{-: string}', [$header => $message]);
+		assertType('array{\'-\': string}', [$header => $message]);
 	}
 }
diff --git a/tests/PHPStan/Analyser/nsrt/bug-7621-1.php b/tests/PHPStan/Analyser/nsrt/bug-7621-1.php
@@ -134,7 +134,7 @@ public function unpackShortcut(string $shortcut, array $supportedGroups): array
 				!array_key_exists($groupOrShortcut, self::SHORTCUTS)
 			) {
 				// Nothing
-				assertType("array{constants: array{'public constants', 'protected constants', 'private constants'}, static properties: array{'public static properties', 'protected static properties', 'private static properties'}, properties: array{'static properties', 'public properties', 'protected properties', 'private properties'}, all public methods: array{'public final methods', 'public static final methods', 'public abstract methods', 'public static abstract methods', 'public static methods', 'public methods'}, all protected methods: array{'protected final methods', 'protected static final methods', 'protected abstract methods', 'protected static abstract methods', 'protected static methods', 'protected methods'}, all private methods: array{'private static methods', 'private methods'}, final methods: array{'public final methods', 'protected final methods', 'public static final methods', 'protected static final methods'}, abstract methods: array{'public abstract methods', 'protected abstract methods', 'public static abstract methods', 'protected static abstract methods'}, static methods: array{'static constructors', 'public static final methods', 'protected static final methods', 'public static abstract methods', 'protected static abstract methods', 'public static methods', 'protected static methods', 'private static methods'}, methods: array{'final methods', 'abstract methods', 'static methods', 'constructor', 'destructor', 'public methods', 'protected methods', 'private methods', 'magic methods'}}", self::SHORTCUTS);
+				assertType("array{constants: array{'public constants', 'protected constants', 'private constants'}, 'static properties': array{'public static properties', 'protected static properties', 'private static properties'}, properties: array{'static properties', 'public properties', 'protected properties', 'private properties'}, 'all public methods': array{'public final methods', 'public static final methods', 'public abstract methods', 'public static abstract methods', 'public static methods', 'public methods'}, 'all protected methods': array{'protected final methods', 'protected static final methods', 'protected abstract methods', 'protected static abstract methods', 'protected static methods', 'protected methods'}, 'all private methods': array{'private static methods', 'private methods'}, 'final methods': array{'public final methods', 'protected final methods', 'public static final methods', 'protected static final methods'}, 'abstract methods': array{'public abstract methods', 'protected abstract methods', 'public static abstract methods', 'protected static abstract methods'}, 'static methods': array{'static constructors', 'public static final methods', 'protected static final methods', 'public static abstract methods', 'protected static abstract methods', 'public static methods', 'protected static methods', 'private static methods'}, methods: array{'final methods', 'abstract methods', 'static methods', 'constructor', 'destructor', 'public methods', 'protected methods', 'private methods', 'magic methods'}}", self::SHORTCUTS);
 				assertType("array{'public final methods', 'protected final methods', 'public static final methods', 'protected static final methods'}", self::SHORTCUTS[self::GROUP_SHORTCUT_FINAL_METHODS]);
 			} else {
 				$groups = array_merge($groups, $this->unpackShortcut($groupOrShortcut, $supportedGroups));
diff --git a/tests/PHPStan/Analyser/nsrt/count-const-array.php b/tests/PHPStan/Analyser/nsrt/count-const-array.php
@@ -65,7 +65,7 @@ public function sayHello(): void
 		];
 		$actualEnabledDays = $this->getEnabledDays();
 		assert(count($expectedDaysResult) === count($actualEnabledDays));
-		assertType("array{2019-01-04: array{'17:00', 'evening'}, 2019-01-05: array{'07:00', 'morning'}, 2019-01-06: array{'12:00', 'afternoon'}, 2019-01-07: array{'10:00', '11:00', '12:00', '13:00', '14:00', '15:00', '16:00', '17:00', 'morning', 'afternoon', 'evening'}, 2019-01-08: array{'07:00', '08:00', '13:00', '19:00', 'morning', 'afternoon', 'evening'}, anyDay: array{'07:00', '08:00', '10:00', '11:00', '12:00', '13:00', '14:00', '15:00', '16:00', '17:00', '19:00', 'morning', 'afternoon', 'evening'}}", $expectedDaysResult);
+		assertType("array{'2019-01-04': array{'17:00', 'evening'}, '2019-01-05': array{'07:00', 'morning'}, '2019-01-06': array{'12:00', 'afternoon'}, '2019-01-07': array{'10:00', '11:00', '12:00', '13:00', '14:00', '15:00', '16:00', '17:00', 'morning', 'afternoon', 'evening'}, '2019-01-08': array{'07:00', '08:00', '13:00', '19:00', 'morning', 'afternoon', 'evening'}, anyDay: array{'07:00', '08:00', '10:00', '11:00', '12:00', '13:00', '14:00', '15:00', '16:00', '17:00', '19:00', 'morning', 'afternoon', 'evening'}}", $expectedDaysResult);
 	}
 
 	/**
diff --git a/tests/PHPStan/Rules/Methods/ReturnTypeRuleTest.php b/tests/PHPStan/Rules/Methods/ReturnTypeRuleTest.php

Original file line number	Diff line number	Diff line change
`@@ -1348,6 +1348,8 @@ public function describe(VerbosityLevel $level): string`
`1348`	`1348`	`$keyDescription = sprintf('\'%s\'', $keyDescription);`
`1349`	`1349`	`} elseif (str_contains($keyDescription, '\'')) {`
`1350`	`1350`	`$keyDescription = sprintf('"%s"', $keyDescription);`
	`1351`	`+ } elseif (!self::isValidIdentifier($keyDescription)) {`
	`1352`	`+ $keyDescription = sprintf('\'%s\'', $keyDescription);`
`1351`	`1353`	`}`
`1352`	`1354`	`}`
`1353`	`1355`
Original file line number	Diff line number	Diff line change
`@@ -1538,7 +1538,7 @@ public static function dataCasts(): array`
`1538`	`1538`	`'(float) $str',`
`1539`	`1539`	`],`
`1540`	`1540`	`[`
`1541`		`- "array{\0TypesNamespaceCasts\\Foo\0foo: TypesNamespaceCasts\\Foo, \0TypesNamespaceCasts\\Foo\0int: int, \0*\0protectedInt: int, publicInt: int, \0TypesNamespaceCasts\\Bar\0barProperty: TypesNamespaceCasts\\Bar}",`
	`1541`	`+ "array{'\0TypesNamespaceCasts\\Foo\0foo': TypesNamespaceCasts\\Foo, '\0TypesNamespaceCasts\\Foo\0int': int, '\0*\0protectedInt': int, publicInt: int, '\0TypesNamespaceCasts\\Bar\0barProperty': TypesNamespaceCasts\\Bar}",`
`1542`	`1542`	`'(array) $foo',`
`1543`	`1543`	`],`
`1544`	`1544`	`[`
Original file line number	Diff line number	Diff line change
`@@ -33,15 +33,15 @@ function withBoolKey(): void`
`33`	`33`	`$c = [false, 'red', 'yellow'];`
`34`	`34`	`$d = ['avocado', 'apple', 'banana'];`
`35`	`35`
`36`		`- assertType("array{: 'avocado', red: 'apple', yellow: 'banana'}", array_combine($c, $d));`
	`36`	`+ assertType("array{'': 'avocado', red: 'apple', yellow: 'banana'}", array_combine($c, $d));`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`function withFloatKey(): void`
`40`	`40`	`{`
`41`	`41`	`$a = [1.5, 'red', 'yellow'];`
`42`	`42`	`$b = ['avocado', 'apple', 'banana'];`
`43`	`43`
`44`		`- assertType("array{1.5: 'avocado', red: 'apple', yellow: 'banana'}", array_combine($a, $b));`
	`44`	`+ assertType("array{'1.5': 'avocado', red: 'apple', yellow: 'banana'}", array_combine($a, $b));`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`function withIntegerKey(): void`
Original file line number	Diff line number	Diff line change
`@@ -26,12 +26,12 @@ class Baz {}`
`26`	`26`	`function withBoolKey() : array`
`27`	`27`	`{`
`28`	`28`	`assertType("array{1: 'b'}", array_fill_keys([true], 'b'));`
`29`		`- assertType("array{: 'b'}", array_fill_keys([false], 'b'));`
	`29`	`+ assertType("array{'': 'b'}", array_fill_keys([false], 'b'));`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`function withFloatKey() : array`
`33`	`33`	`{`
`34`		`- assertType("array{1.5: 'b'}", array_fill_keys([1.5], 'b'));`
	`34`	`+ assertType("array{'1.5': 'b'}", array_fill_keys([1.5], 'b'));`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`function withIntegerKey() : array`
Original file line number	Diff line number	Diff line change
`@@ -17,8 +17,8 @@ class Foo`
`17`	`17`	`*/`
`18`	`18`	`public function doFoo(array $slash, array $dollar): void`
`19`	`19`	`{`
`20`		`- assertType('array{namespace/key: string}', $slash);`
`21`		`- assertType('array<int, array{$ref: string}>', $dollar);`
	`20`	`+ assertType("array{'namespace/key': string}", $slash);`
	`21`	`+ assertType('array<int, array{\'$ref\': string}>', $dollar);`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ public function parse(string $glue): string`
`13`	`13`	`{`
`14`	`14`	`$seenGlues = ['\|' => false, '&' => false];`
`15`	`15`
`16`		`- assertType("array{\|: false, &: false}", $seenGlues);`
	`16`	`+ assertType("array{'\|': false, '&': false}", $seenGlues);`
`17`	`17`
`18`	`18`	`if ($glue !== '') {`
`19`	`19`	`assertType('non-empty-string', $glue);`
`@@ -22,13 +22,13 @@ public function parse(string $glue): string`
`22`	`22`	`$seenGlues[$glue] = true;`
`23`	`23`
`24`	`24`	`assertType("'&'\|'\|'", $glue);`
`25`		`- assertType('array{\|: bool, &: bool}', $seenGlues);`
	`25`	`+ assertType("array{'\|': bool, '&': bool}", $seenGlues);`
`26`	`26`	`} else {`
`27`	`27`	`assertType("''", $glue);`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`assertType("''\|'&'\|'\|'", $glue);`
`31`		`- assertType("array{\|: bool, &: bool}", $seenGlues);`
	`31`	`+ assertType("array{'\|': bool, '&': bool}", $seenGlues);`
`32`	`32`
`33`	`33`	`return array_key_first($seenGlues);`
`34`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,6 @@ protected function bar(string $message): void`
`20`	`20`	`$header = sprintf('%s-%s', '', '');`
`21`	`21`
`22`	`22`	`assertType('\'-\'', $header);`
`23`		`- assertType('array{-: string}', [$header => $message]);`
	`23`	`+ assertType('array{\'-\': string}', [$header => $message]);`
`24`	`24`	`}`
`25`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ public function sayHello(): void`
`65`	`65`	`];`
`66`	`66`	`$actualEnabledDays = $this->getEnabledDays();`
`67`	`67`	`assert(count($expectedDaysResult) === count($actualEnabledDays));`
`68`		- assertType("array{2019-01-04: array{'17:00', 'evening'}, 2019-01-05: array{'07:00', 'morning'}, 2019-01-06: array{'12:00', 'afternoon'}, 2019-01-07: array{'10:00', '11:00', '12:00', '13:00', '14:00', '15:00', '16:00', '17:00', 'morning', 'afternoon', 'evening'}, 2019-01-08: array{'07:00', '08:00', '13:00', '19:00', 'morning', 'afternoon', 'evening'}, anyDay: array{'07:00', '08:00', '10:00', '11:00', '12:00', '13:00', '14:00', '15:00', '16:00', '17:00', '19:00', 'morning', 'afternoon', 'evening'}}", $expectedDaysResult);
	`68`	+ assertType("array{'2019-01-04': array{'17:00', 'evening'}, '2019-01-05': array{'07:00', 'morning'}, '2019-01-06': array{'12:00', 'afternoon'}, '2019-01-07': array{'10:00', '11:00', '12:00', '13:00', '14:00', '15:00', '16:00', '17:00', 'morning', 'afternoon', 'evening'}, '2019-01-08': array{'07:00', '08:00', '13:00', '19:00', 'morning', 'afternoon', 'evening'}, anyDay: array{'07:00', '08:00', '10:00', '11:00', '12:00', '13:00', '14:00', '15:00', '16:00', '17:00', '19:00', 'morning', 'afternoon', 'evening'}}", $expectedDaysResult);
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`/**`