@immutable class cannot be passed by-ref

Author: staabm

src/Rules/FunctionCallParametersCheck.php

@@ -409,14 +409,21 @@ public function check(
 					if ($nativePropertyReflection === null) {
 						continue;
 					}
-					if (!$nativePropertyReflection->isReadOnly()) {
-						continue;
-					}
 
-					if ($nativePropertyReflection->isStatic()) {
-						$propertyDescription = sprintf('static readonly property %s::$%s', $propertyReflection->getDeclaringClass()->getDisplayName(), $propertyReflection->getName());
+					if ($nativePropertyReflection->isReadOnly()) {
+						if ($nativePropertyReflection->isStatic()) {
+							$propertyDescription = sprintf('static readonly property %s::$%s', $propertyReflection->getDeclaringClass()->getDisplayName(), $propertyReflection->getName());
+						} else {
+							$propertyDescription = sprintf('readonly property %s::$%s', $propertyReflection->getDeclaringClass()->getDisplayName(), $propertyReflection->getName());
+						}
+					} elseif ($nativePropertyReflection->isReadOnlyByPhpDoc()) {
+						if ($nativePropertyReflection->isStatic()) {
+							$propertyDescription = sprintf('static @readonly property %s::$%s', $propertyReflection->getDeclaringClass()->getDisplayName(), $propertyReflection->getName());
+						} else {
+							$propertyDescription = sprintf('@readonly property %s::$%s', $propertyReflection->getDeclaringClass()->getDisplayName(), $propertyReflection->getName());
+						}
 					} else {
-						$propertyDescription = sprintf('readonly property %s::$%s', $propertyReflection->getDeclaringClass()->getDisplayName(), $propertyReflection->getName());
+						continue;
 					}
 
 					$errors[] = RuleErrorBuilder::message(sprintf(

tests/PHPStan/Rules/Functions/CallToFunctionParametersRuleTest.php

@@ -1982,4 +1982,22 @@ public function testBug3107(): void
 		$this->analyse([__DIR__ . '/data/bug-3107.php'], []);
 	}
 
+	public function testBug12676(): void
+	{
+		$this->analyse([__DIR__ . '/data/bug-12676.php'], [
+			[
+				'Parameter #1 $array is passed by reference so it does not accept @readonly property Bug12676\A::$a.',
+				15,
+			],
+			[
+				'Parameter #1 $array is passed by reference so it does not accept @readonly property Bug12676\B::$readonlyArr.',
+				25,
+			],
+			[
+				'Parameter #1 $array is passed by reference so it does not accept static @readonly property Bug12676\C::$readonlyArr.',
+				35,
+			],
+		]);
+	}
+
 }

tests/PHPStan/Rules/Functions/data/bug-12676.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Bug12676;
+
+/**
+ * @immutable
+ */
+class A {
+
+	/** @var array<string, int> */
+	public array $a;
+
+	public function __construct() {
+		$this->a = ['b' => 2, 'a' => 1];
+		ksort($this->a);
+	}
+}
+
+class B {
+	/** @readonly */
+	public array $readonlyArr;
+
+	public function __construct() {
+		$this->readonlyArr = ['b' => 2, 'a' => 1];
+		ksort($this->readonlyArr);
+	}
+}
+
+class C {
+	/** @readonly */
+	static public array $readonlyArr;
+
+	public function __construct() {
+		self::$readonlyArr = ['b' => 2, 'a' => 1];
+		ksort(self::$readonlyArr);
+	}
+}