danog/psalm
1
0
Fork 0
mirror of https://github.com/danog/psalm.git synced 2024-11-30 04:39:00 +01:00
Code Issues Projects Releases Wiki Activity

Update naming to mutate

Browse Source
This commit is contained in:
Christian Kolb 2020-02-02 21:03:17 +01:00 committed by Matthew Brown
parent 143756800f
commit fd6cdf61c7
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/annotating_code/supported_annotations.md
View File

@ -324,13 +324,13 @@ echo Arithmetic::addCumulative(3); // outputs 3
echo Arithmetic::addCumulative(3); // outputs 6
```
### `@psalm-private-set`
### `@psalm-private-mutate`
Used to annotate properties which can only be set in a private context. With this, public properties can be read from another class but only be modified within a method of its own class.
Used to annotate properties which can only be mutated in a private context. With this, public properties can be read from another class but only be mutated within a method of its own class.
```php
class Counter {
/** @psalm-private-set */
/** @psalm-private-mutate */
public int $count = 0;
public function increment() : void {
@ -340,9 +340,9 @@ class Counter {
$counter = new Counter();
echo $counter->count; // outputs 0
$counter->increment(); // Method can modify property
$counter->increment(); // Method can mutate property
echo $counter->count; // outputs 1
$counter->count = 5; // This will fail as it's modifying a property directly
$counter->count = 5; // This will fail as it's mutating a property directly
```
## Type Syntax