Skip to content

Fix #12253: assign.readOnlyProperty #5061

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
VincentLanglet merged 3 commits into from
Mar 28, 2026
Merged

Fix #12253: assign.readOnlyProperty #5061

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9ec0cbd
Fix false positive "readonly property already assigned" in method cal…
phpstan-bot Feb 27, 2026
7f6add5
Also check PropertyInitializationExpr scope for additional constructors
phpstan-bot Mar 26, 2026
6d4a2d0
Add test for bug-12253 with additionalConstructors configured
phpstan-bot Mar 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions src/Node/ClassPropertiesNode.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,10 +166,9 @@ public function getUninitializedProperties(
$initializedInConstructor = array_diff_key($uninitializedProperties, $this->collectUninitializedProperties([$classReflection->getConstructor()->getName()], $uninitializedProperties));
}

$methodsCalledFromConstructor = $this->getMethodsCalledFromConstructor($classReflection, $initialInitializedProperties, $initializedProperties, $constructors, $initializedInConstructor);
$methodsCalledFromConstructor = $this->getMethodsCalledFromConstructor($classReflection, $initialInitializedProperties, $initializedProperties, $constructors, $initializedInConstructor, $constructors);
$prematureAccess = [];
$additionalAssigns = [];

foreach ($this->getPropertyUsages() as $usage) {
$fetch = $usage->getFetch();
if (!$fetch instanceof PropertyFetch) {
Expand Down Expand Up @@ -211,7 +210,10 @@ public function getUninitializedProperties(

if ($usage instanceof PropertyWrite) {
if (array_key_exists($propertyName, $initializedPropertiesMap)) {
$hasInitialization = $initializedPropertiesMap[$propertyName]->or($usageScope->hasExpressionType(new PropertyInitializationExpr($propertyName)));
$hasInitialization = $initializedPropertiesMap[$propertyName];
if (strtolower($function->getName()) === '__construct') {
Copy link
Copy Markdown
Contributor

@staabm staabm Mar 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

when seeing such comparison it reminds me that we have a NEON config additionalConstructors. is this somehow related/should be taken into account?

Copy link
Copy Markdown
Collaborator Author

@phpstan-bot phpstan-bot Mar 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All background tasks confirmed successful. The fix is committed and pushed.

$hasInitialization = $hasInitialization->or($usageScope->hasExpressionType(new PropertyInitializationExpr($propertyName)));
}
if (
!$hasInitialization->no()
&& !$usage->isPromotedPropertyWrite()
Expand Down Expand Up @@ -318,6 +320,7 @@ private function collectUninitializedProperties(array $constructors, array $unin
* @param array<string, TrinaryLogic> $initialInitializedProperties
* @param array<string, array<string, TrinaryLogic>> $initializedProperties
* @param array<string, ClassPropertyNode> $initializedInConstructorProperties
* @param string[] $originalConstructors
*
* @return array<string, array<string, TrinaryLogic>>
*/
Expand All @@ -327,6 +330,7 @@ private function getMethodsCalledFromConstructor(
array $initializedProperties,
array $methods,
array $initializedInConstructorProperties,
array $originalConstructors,
): array
{
$originalMap = $initializedProperties;
Expand Down Expand Up @@ -363,7 +367,7 @@ private function getMethodsCalledFromConstructor(
continue;
}

if ($inMethod->getName() !== '__construct') {
if ($inMethod->getName() !== '__construct' && in_array($inMethod->getName(), $originalConstructors, true)) {
foreach (array_keys($initializedInConstructorProperties) as $propertyName) {
$initializedProperties[$inMethod->getName()][$propertyName] = TrinaryLogic::createYes();
}
Expand Down Expand Up @@ -391,7 +395,7 @@ private function getMethodsCalledFromConstructor(
return $initializedProperties;
}

return $this->getMethodsCalledFromConstructor($classReflection, $initialInitializedProperties, $initializedProperties, $methods, $initializedInConstructorProperties);
return $this->getMethodsCalledFromConstructor($classReflection, $initialInitializedProperties, $initializedProperties, $methods, $initializedInConstructorProperties, $originalConstructors);
}

/**
Expand Down
6 changes: 6 additions & 0 deletions tests/PHPStan/Rules/Properties/MissingReadOnlyPropertyAssignRuleTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,4 +342,10 @@ public function testBug11828(): void
$this->analyse([__DIR__ . '/data/bug-11828.php'], []);
}

#[RequiresPhp('>= 8.4')]
public function testBug12253(): void
{
$this->analyse([__DIR__ . '/data/bug-12253.php'], []);
}

}
87 changes: 87 additions & 0 deletions tests/PHPStan/Rules/Properties/data/bug-12253.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
<?php // lint >= 8.4

declare(strict_types = 1);
Copy link
Copy Markdown
Contributor

@staabm staabm Mar 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add another test with the same problem, but 1 additionalConstructors configured

Copy link
Copy Markdown
Collaborator Author

@phpstan-bot phpstan-bot Mar 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're out of extra usage · resets 5pm (UTC)

Copy link
Copy Markdown
Contributor

@staabm staabm Mar 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add another test with the same problem, but 1 additionalConstructors configured

Copy link
Copy Markdown
Collaborator Author

@phpstan-bot phpstan-bot Mar 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. I've addressed staabm's review by adding a PayloadWithAdditionalConstructor test class to bug-12253.php that reproduces the same readonly property false positive scenario but with setUp() configured as an additional constructor via ConstructorsHelper. The test verifies no false positive is reported when a helper method (called from the additional constructor) assigns a readonly property while also calling other methods.


namespace Bug12253;

use stdClass;

class Payload
{
/** @var array<array<string, mixed>> */
private(set) readonly array $validation;

/** @var array<string, string> */
private array $ids = [];

public function __construct(private readonly stdClass $payload)
{
$this->parseValidation();
}

private function parseValidation(): void
{
$validations = [];

foreach ($this->payload->validation as $key => $validation) {
$validations[] = [
'id' => $key,
'field_id' => $this->ids[$validation->field_id],
'rule' => $validation->rule,
'value' => $this->validationValue($validation->value),
'message' => $validation->message,
];
}

$this->validation = $validations;
}

private function validationValue(mixed $value): mixed
{
if (is_null($value)) {
return null;
}

return $this->ids[$value] ?? $value;
}
}

class PayloadWithoutAsymmetricVisibility
{
/** @var array<array<string, mixed>> */
private readonly array $validation;

/** @var array<string, string> */
private array $ids = [];

public function __construct(private readonly stdClass $payload)
{
$this->parseValidation();
}

private function parseValidation(): void
{
$validations = [];

foreach ($this->payload->validation as $key => $validation) {
$validations[] = [
'id' => $key,
'field_id' => $this->ids[$validation->field_id],
'rule' => $validation->rule,
'value' => $this->validationValue($validation->value),
'message' => $validation->message,
];
}

$this->validation = $validations;
}

private function validationValue(mixed $value): mixed
{
if (is_null($value)) {
return null;
}

return $this->ids[$value] ?? $value;
}
}
Loading