icanhazstring / phpstan-readonly-property
Support #[IsReadonly] promoted constructor properties for PHPStan
Installs: 12 653
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 1
Forks: 1
Open Issues: 0
Requires
- php: ^8.0
- phpstan/phpstan: ^0.12.55 || ^1.0
Requires (Dev)
- phpunit/phpunit: ^9.5
README
Support #[IsReadonly]
class properties for PHPStan.
This library is used to have a transition from PHP 8.0 to 8.1 until readonly
keyword will be introduced.
Installation
composer require --dev icanhazstring/phpstan-readonly-property
Then use PHPStan Extension Installer using
composer require --dev phpstan/extension-installer
or manually add vendor/icanhazstring/phpstan-readonly-property/rules.neon
into your phpstan.neon
configuration.
# phpstan.neon includes: - vendor/icanhazstring/phpstan-readonly-property/rules.neon
Usage
Add #[IsReadonly]
to the property you want to have readonly only.
<?php final class User { public function __constrct( #[IsReadonly] public string $name ) {} } $user = new User('fu'); $user->name = 'bar'; // Will fail
Known limitations
There are some limitations to the static analysis from using 8.1 readonly
flag.
Use of multiple setters can't be checked
If you are initializing your #[IsReadonly]
property using a setter, PHPStan can NOT detect
multiple calls of that setter to a readonly property.
final class Fu
{
#[IsReadonly]
public string $value;
public function setValue(string $value)
{
$this->value = $value;
}
}
$fu = new Fu();
$fu->setValue('bar');
$fu->setValue('baz'); // Will work with this extension, but NOT with 8.1 `readonly`