Skip to content

Fix #6777: Bogus write-only error when appending to an array-like object in private class property #5102

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 4 commits into from
Mar 29, 2026
Merged

Fix #6777: Bogus write-only error when appending to an array-like object in private class property #5102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b8c6b6b
Fix bogus write-only error when appending to ArrayAccess property
github-actions[bot] Feb 28, 2026
0ca9912
Broaden write-only property check to all objects, not just ArrayAccess
phpstan-bot Mar 28, 2026
0ab8b71
Broaden write-only property check to cover union types and non-ArrayA…
phpstan-bot Mar 28, 2026
cd941fc
Add assign-by-reference test case for bug-6777
phpstan-bot Mar 29, 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
12 changes: 11 additions & 1 deletion src/Node/ClassStatementsGatherer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
use PhpParser\Node\Identifier;
use PHPStan\Analyser\Scope;
use PHPStan\Node\Constant\ClassConstantFetch;
use PHPStan\Node\Expr\SetExistingOffsetValueTypeExpr;
use PHPStan\Node\Expr\SetOffsetValueTypeExpr;
use PHPStan\Node\Property\PropertyAssign;
use PHPStan\Node\Property\PropertyRead;
use PHPStan\Node\Property\PropertyWrite;
Expand Down Expand Up @@ -200,7 +202,15 @@ private function gatherNodes(Node $node, Scope $scope): void
return;
}
if ($node instanceof PropertyAssignNode) {
$this->propertyUsages[] = new PropertyWrite($node->getPropertyFetch(), $scope, false);
$propertyFetch = $node->getPropertyFetch();
$assignedExpr = $node->getAssignedExpr();
if ($assignedExpr instanceof SetOffsetValueTypeExpr || $assignedExpr instanceof SetExistingOffsetValueTypeExpr) {
$propertyType = $scope->getType($propertyFetch);
if (!$propertyType->isObject()->no()) {
$this->propertyUsages[] = new PropertyRead($propertyFetch, $scope);
}
}
$this->propertyUsages[] = new PropertyWrite($propertyFetch, $scope, false);
$this->propertyAssigns[] = new PropertyAssign($node, $scope);
return;
}
Expand Down
19 changes: 9 additions & 10 deletions tests/PHPStan/Rules/DeadCode/UnusedPrivatePropertyRuleTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,16 +130,6 @@ public function testRule(): void
191,
$tip,
],
[
'Property UnusedPrivateProperty\WriteToCollection::$collection1 is never read, only written.',
221,
$tip,
],
[
'Property UnusedPrivateProperty\WriteToCollection::$collection2 is never read, only written.',
224,
$tip,
],
]);
$this->analyse([__DIR__ . '/data/TestExtension.php'], [
[
Expand Down Expand Up @@ -410,4 +400,13 @@ public function testBug9213(): void
$this->analyse([__DIR__ . '/data/bug-9213.php'], []);
}

#[RequiresPhp('>= 8.0')]
public function testBug6777(): void
{
$this->alwaysWrittenTags = [];
$this->alwaysReadTags = [];

$this->analyse([__DIR__ . '/data/bug-6777.php'], []);
}

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

declare(strict_types = 1);

namespace Bug6777;

class HelloWorld
{
/** @param \ArrayObject<int, string> $array */
public function __construct(private \ArrayObject $array){}

public function send(string $s) : void{
$this->array[] = $s;
Copy link
Copy Markdown
Contributor

@staabm staabm Mar 29, 2026

Choose a reason for hiding this comment

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

Add a similar test with assign by reference

Copy link
Copy Markdown
Collaborator Author

@phpstan-bot phpstan-bot Mar 29, 2026

Choose a reason for hiding this comment

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

Background task confirmed — make tests completed successfully as well. Everything was already verified and pushed.

}
}

class WithThreaded
{
private \Threaded $collection;

public function __construct()
{
$this->collection = new \Threaded();
}

public function add(string $s): void
{
$this->collection[] = $s;
}
}

class WithUnionObjectArray
{
/** @var \ArrayObject<int, string>|array<int, string> */
private \ArrayObject|array $collection;

/** @param \ArrayObject<int, string>|array<int, string> $collection */
public function __construct(\ArrayObject|array $collection)
{
$this->collection = $collection;
}

public function add(string $s): void
{
$this->collection[] = $s;
}
}

class WithAssignByReference
{
/** @param \ArrayObject<int, string> $array */
public function __construct(private \ArrayObject $array){}

public function send(string &$s) : void{
$this->array[] =& $s;
}
}

class WithUnionObjectString
{
/** @var \ArrayObject<int, string>|string */
private \ArrayObject|string $collection;

/** @param \ArrayObject<int, string>|string $collection */
public function __construct(\ArrayObject|string $collection)
{
$this->collection = $collection;
}

public function add(string $s): void
{
$this->collection[] = $s;
}
}
Loading