Skip to content

Readonly properties cannot be unset() #3827

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
merged 6 commits into from
Feb 28, 2025
Merged

Readonly properties cannot be unset() #3827

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f26ae2f
Readonly properties cannot be unset()
staabm Feb 15, 2025
c07127c
fix unset on stdClass
staabm Feb 15, 2025
ca308ab
test subclass
staabm Feb 16, 2025
aa238e2
fix
staabm Feb 27, 2025
c4c7b8c
Utilize PropertyReflectionFinder
staabm Feb 28, 2025
71ff1f6
Yennefer of Vengerberg ;)
staabm Feb 28, 2025
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
25 changes: 25 additions & 0 deletions src/Rules/Variables/UnsetRule.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,31 @@ private function canBeUnset(Node $node, Scope $scope): ?IdentifierRuleError
}

return $this->canBeUnset($node->var, $scope);
} elseif (
$node instanceof Node\Expr\PropertyFetch
&& $node->name instanceof Node\Identifier
) {
Copy link
Member

Choose a reason for hiding this comment

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

We have better ways of getting a property reflection from PropertyFetch. Two actually:

  1. PropertyReflectionFinder. FoundPropertyReflection will even tell you if it's a native one or not.
  2. Scope::getPropertyReflection()

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ahh nice.

I was already searching how to know about property hooks so I can implement the error for unsetting a hooked property.

will be a followup PR

Copy link
Member

Choose a reason for hiding this comment

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

I wrote about property hooks here phpstan/phpstan#12337

$type = $scope->getType($node->var);
foreach ($type->getObjectClassReflections() as $classReflection) {
if (!$classReflection->hasNativeProperty($node->name->name)) {
continue;
}

$propertyReflection = $classReflection->getNativeProperty($node->name->name);
if ($propertyReflection->isReadOnly() || $propertyReflection->isReadOnlyByPhpDoc()) {
return RuleErrorBuilder::message(
sprintf(
'Cannot unset %s property %s of %s.',
$propertyReflection->isReadOnly() ? 'readonly' : '@readonly',
$node->name->name,
$type->describe(VerbosityLevel::value()),
),
)
->line($node->getStartLine())
->identifier($propertyReflection->isReadOnly() ? 'unset.readOnlyProperty' : 'unset.readOnlyPropertyByPhpDoc')
->build();
}
}
}

return null;
Expand Down
30 changes: 30 additions & 0 deletions tests/PHPStan/Rules/Variables/UnsetRuleTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,4 +91,34 @@ public function testBug4565(): void
$this->analyse([__DIR__ . '/../../Analyser/nsrt/bug-4565.php'], []);
}

public function testBug12421(): void
{
$this->analyse([__DIR__ . '/data/bug-12421.php'], [
[
'Cannot unset readonly property y of Bug12421\NativeReadonlyClass.',
11,
],
[
'Cannot unset readonly property y of Bug12421\NativeReadonlyProperty.',
15,
],
[
'Cannot unset @readonly property y of Bug12421\PhpdocReadonlyClass.',
19,
],
[
'Cannot unset @readonly property y of Bug12421\PhpdocReadonlyProperty.',
23,
],
[
'Cannot unset @readonly property y of Bug12421\PhpdocImmutableClass.',
27,
],
[
'Cannot unset readonly property y of Bug12421\NativeReadonlyPropertySubClass.',
34,
],
]);
}

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

namespace Bug12421;

function doFoo() {
$x = new RegularProperty();
unset($x->y);
var_dump($x->y);

$x = new NativeReadonlyClass();
unset($x->y);
var_dump($x->y);

$x = new NativeReadonlyProperty();
unset($x->y);
var_dump($x->y);

$x = new PhpdocReadonlyClass();
unset($x->y);
var_dump($x->y);

$x = new PhpdocReadonlyProperty();
unset($x->y);
var_dump($x->y);

$x = new PhpdocImmutableClass();
unset($x->y);
var_dump($x->y);

$x = new \stdClass();
unset($x->y);

$x = new NativeReadonlyPropertySubClass();
unset($x->y);
var_dump($x->y);
}

readonly class NativeReadonlyClass
{
public Y $y;

public function __construct()
{
$this->y = new Y();
}
}

class NativeReadonlyProperty
{
public readonly Y $y;

public function __construct()
{
$this->y = new Y();
}
}

/** @readonly */
class PhpdocReadonlyClass
{
public Y $y;

public function __construct()
{
$this->y = new Y();
}
}

class PhpdocReadonlyProperty
{
/** @readonly */
public Y $y;

public function __construct()
{
$this->y = new Y();
}
}

/** @immutable */
class PhpdocImmutableClass
{
public Y $y;

public function __construct()
{
$this->y = new Y();
}
}

class RegularProperty
{
public Y $y;

public function __construct()
{
$this->y = new Y();
}
}

class NativeReadonlyPropertySubClass extends NativeReadonlyProperty
{
}

class Y
{
}

Loading