← All results

@psalm-immutable

Group: Advanced PHPDoc types · Category: ecosystem · File: phpdoc_advanced_psalm_immutable.php

Class-level immutability: public properties behave as readonly for consumers and non-constructor methods must not mutate $this. References: - Psalm supported_annotations.md: @psalm-immutable

Analyzer results

AnalyzerVersionResultDiagnostics
phan 6.0.7Phan 6.0.7 php-ast version 1.1.3 PHP version used to run Phan: 8.5.9 Not enforced

No diagnostics reported.

  • Recognition: spelling resolved
  • Enforcement: 0/2 of the expected violations reported
phpstan 2.2.8PHPStan - PHP Static Analysis Tool 2.2.8 Partly enforced (1/2) reported Lv.3+
phpdoc_advanced_psalm_immutable.php:29: @readonly property Conformance\Tests\PhpdocAdvancedPsalmImmutable\Point::$label is assigned outside of the constructor. [identifier=property.readOnlyByPhpDocAssignNotInConstructor] [reported-from-level=3]
phpdoc_advanced_psalm_immutable.php:34: @readonly property Conformance\Tests\PhpdocAdvancedPsalmImmutable\Point::$label is assigned outside of its declaring class. [identifier=property.readOnlyByPhpDocAssignOutOfClass] [reported-from-level=3]
With strict-rules
phpdoc_advanced_psalm_immutable.php:29: @readonly property Conformance\Tests\PhpdocAdvancedPsalmImmutable\Point::$label is assigned outside of the constructor. [identifier=property.readOnlyByPhpDocAssignNotInConstructor]
phpdoc_advanced_psalm_immutable.php:34: @readonly property Conformance\Tests\PhpdocAdvancedPsalmImmutable\Point::$label is assigned outside of its declaring class. [identifier=property.readOnlyByPhpDocAssignOutOfClass]
  • Recognition: spelling resolved
  • Enforcement: 1/2 of the expected violations reported
Expectation diff
Line 34: Expected valid value to be accepted, got ["@readonly property Conformance\\Tests\\PhpdocAdvancedPsalmImmutable\\Point::$label is assigned outside of its declaring class. [identifier=property.readOnlyByPhpDocAssignOutOfClass] [reported-from-level=3]"]
psalm 6.16.1Psalm 6.16.1@f1f5de594dc76faf8784e02d3dc4716c91c6f6ac
next: 7.0.0-beta19
Partly enforced (1/2)
phpdoc_advanced_psalm_immutable.php:29: Conformance\Tests\PhpdocAdvancedPsalmImmutable\Point::$label is marked readonly [InaccessibleProperty]
phpdoc_advanced_psalm_immutable.php:34: Conformance\Tests\PhpdocAdvancedPsalmImmutable\Point::$label is marked readonly [InaccessibleProperty]
  • Recognition: spelling resolved
  • Enforcement: 1/2 of the expected violations reported
Expectation diff
Line 34: Expected valid value to be accepted, got ["Conformance\\Tests\\PhpdocAdvancedPsalmImmutable\\Point::$label is marked readonly [InaccessibleProperty]"]
mago 1.46.0mago 1.46.0 Not enforced

No diagnostics reported.

  • Recognition: spelling resolved
  • Enforcement: 0/2 of the expected violations reported
mir 0.70.1mir 0.70.1 Partly enforced (1/2)
phpdoc_advanced_psalm_immutable.php:29: ImmutablePropertyModification: Assigning to property label of $this in an immutable context (@psalm-immutable class or @psalm-mutation-free method) [MIR1705]
phpdoc_advanced_psalm_immutable.php:34: ImmutablePropertyModification: Assigning to property label of $point in an immutable context (@psalm-immutable class or @psalm-mutation-free method) [MIR1705]
  • Recognition: spelling resolved
  • Enforcement: 1/2 of the expected violations reported
Expectation diff
Line 34: Expected valid value to be accepted, got ["ImmutablePropertyModification: Assigning to property label of $point in an immutable context (@psalm-immutable class or @psalm-mutation-free method) [MIR1705]"]
phpantom 0.9.0phpantom_lsp 0.9.0 Not enforced

No diagnostics reported.

  • Recognition: spelling resolved
  • Enforcement: 0/2 of the expected violations reported
intelephense 1.18.5intelephense 1.18.5 Not enforced

No diagnostics reported.

  • Recognition: spelling resolved
  • Enforcement: 0/2 of the expected violations reported
phpy 0.2.0phpy 0.2.0 Not enforced

No diagnostics reported.

  • Recognition: spelling resolved
  • Enforcement: 0/2 of the expected violations reported
qodana 262.8665.325Qodana 262.8665.325 Not enforced

No diagnostics reported.

  • Recognition: spelling resolved
  • Enforcement: 0/2 of the expected violations reported
noverify 0.5.5NoVerify, version 0.5.5: built on: 2025.04.22 14:36:46 OS: r-kuchinskas arm64 Commit: 4774b82f8adc53fbef38f95e97af4b953b4d1529 Not enforced

No diagnostics reported.

  • Recognition: spelling resolved
  • Enforcement: 0/2 of the expected violations reported
steins 0.1.5steins 0.1.5 (2026-08-12 revision 39b4cc1) Not enforced

No diagnostics reported.

  • Recognition: spelling resolved
  • Enforcement: 0/2 of the expected violations reported
phpstan-strict 2.2.8PHPStan - PHP Static Analysis Tool 2.2.8 Partly enforced (1/2)
phpdoc_advanced_psalm_immutable.php:29: @readonly property Conformance\Tests\PhpdocAdvancedPsalmImmutable\Point::$label is assigned outside of the constructor. [identifier=property.readOnlyByPhpDocAssignNotInConstructor]
phpdoc_advanced_psalm_immutable.php:34: @readonly property Conformance\Tests\PhpdocAdvancedPsalmImmutable\Point::$label is assigned outside of its declaring class. [identifier=property.readOnlyByPhpDocAssignOutOfClass]
  • Recognition: spelling resolved
  • Enforcement: 1/2 of the expected violations reported
Expectation diff
Line 34: Expected valid value to be accepted, got ["@readonly property Conformance\\Tests\\PhpdocAdvancedPsalmImmutable\\Point::$label is assigned outside of its declaring class. [identifier=property.readOnlyByPhpDocAssignOutOfClass]"]
psalm-next 7.0.0-beta19Psalm 7.0.0-beta19@7e751c06a756fa64dc4c759c09fe4a173afcb433 Partly enforced (1/2)
phpdoc_advanced_psalm_immutable.php:29: Conformance\Tests\PhpdocAdvancedPsalmImmutable\Point::$label is marked readonly [InaccessibleProperty]
phpdoc_advanced_psalm_immutable.php:29: The context allows only reading instance state but property assignment to Conformance\Tests\PhpdocAdvancedPsalmImmutable\Point::$label is mutating instance state [ImpurePropertyAssignment]
phpdoc_advanced_psalm_immutable.php:34: Conformance\Tests\PhpdocAdvancedPsalmImmutable\Point::$label is marked readonly [InaccessibleProperty]
  • Recognition: spelling resolved
  • Enforcement: 1/2 of the expected violations reported
Expectation diff
Line 34: Expected valid value to be accepted, got ["Conformance\\Tests\\PhpdocAdvancedPsalmImmutable\\Point::$label is marked readonly [InaccessibleProperty]"]

Source

<?php

declare(strict_types=1);

namespace Conformance\Tests\PhpdocAdvancedPsalmImmutable;

/**
 * Cross-tool handling of `@psalm-immutable`.
 *
 * Class-level immutability: public properties behave as readonly for consumers
 * and non-constructor methods must not mutate `$this`.
 *
 * References:
 * - Psalm supported_annotations.md: `@psalm-immutable`
 */

/**
 * @psalm-immutable
 */
final class Point // T: @psalm-immutable
{
    public function __construct(
        public string $label,
    ) {
    }

    public function relabel(string $label): void
    {
        $this->label = $label; // E?: mutation inside immutable class method
    }
}

$point = new Point('origin'); // V
echo $point->label; // V
$point->label = 'moved'; // E?: immutable property assigned outside constructor