← All results

@phan-assert

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

Phan's unconditional assertion tag, parallel to @psalm-assert / @phpstan-assert. After the call, supporting tools treat the argument as the asserted type. References: - Phan Annotating-Your-Source-Code-V6.md: @phan-assert - Psalm adding_assertions.md / PHPStan narrowing-types.md

Analyzer results

AnalyzerVersionResultDiagnostics
phan 6.0.10Phan 6.0.10 php-ast version 1.1.3 PHP version used to run Phan: 8.5.11 Not enforced

No diagnostics reported.

  • Recognition: spelling resolved
  • Enforcement: 0/1 of the expected violations reported
phpstan 2.3.1PHPStan - PHP Static Analysis Tool 2.3.1 Enforced reported Lv.4+
phpdoc_advanced_vendor_prefixed_assert_phan.php:43: Call to function is_string() with int will always evaluate to false. [reported-from-level=4]
With strict-rules
phpdoc_advanced_vendor_prefixed_assert_phan.php:43: Call to function is_string() with int will always evaluate to false.
  • Recognition: spelling resolved
  • Enforcement: 1/1 of the expected violations reported
psalm 6.20.0Psalm 6.20.0@804f03c0c183d149fcd4b8c7c0c9b3fbf836d34c
next: 7.0.0-rc2
Enforced (pzoom≠)
phpdoc_advanced_vendor_prefixed_assert_phan.php:37: Argument 1 of Conformance\Tests\PhpdocAdvancedVendorPrefixedAssertPhan\takesInt cannot be mixed, expecting int [MixedArgument]
phpdoc_advanced_vendor_prefixed_assert_phan.php:43: Type int for $value is never string [TypeDoesNotContainType]
phpdoc_advanced_vendor_prefixed_assert_phan.php:43: Type int for $value is never string [RedundantCondition]
pzoom (Psalm port)
phpdoc_advanced_vendor_prefixed_assert_phan.php:37: Argument 1 of takesInt cannot be mixed, expecting int [MixedArgument]
  • Recognition: spelling resolved
  • Enforcement: 1/1 of the expected violations reported
Expectation diff
Line 37: Expected valid value to be accepted, got ["Argument 1 of Conformance\\Tests\\PhpdocAdvancedVendorPrefixedAssertPhan\\takesInt cannot be mixed, expecting int [MixedArgument]"]
mago 1.57.0mago 1.57.0 Enforced
phpdoc_advanced_vendor_prefixed_assert_phan.php:43: Impossible type assertion: `$value` of type `int` can never be `string`. [impossible-type-comparison]
phpdoc_advanced_vendor_prefixed_assert_phan.php:43: Redundant ternary operator: condition is always falsy. [impossible-condition]
  • Recognition: spelling resolved
  • Enforcement: 1/1 of the expected violations reported
mir 0.87.0mir 0.87.0 Not enforced
phpdoc_advanced_vendor_prefixed_assert_phan.php:37: MixedArgument: Argument $value of takesInt() is mixed [MIR1200]
  • Recognition: spelling resolved
  • Enforcement: 0/1 of the expected violations reported
Expectation diff
Line 37: Expected valid value to be accepted, got ["MixedArgument: Argument $value of takesInt() is mixed [MIR1200]"]
phpantom 0.11.1phpantom_lsp 0.11.1 Not enforced

No diagnostics reported.

  • Recognition: spelling resolved
  • Enforcement: 0/1 of the expected violations reported
intelephense 1.18.5intelephense 1.18.5 Incidental (0/1)
phpdoc_advanced_vendor_prefixed_assert_phan.php:37: Expected type 'int'. Found 'mixed'. [P1006]
  • Recognition: spelling resolved
  • Enforcement: 0/1 of the expected violations reported — incidental, since values the type admits were also rejected on line(s) 37
Expectation diff
Line 37: Expected valid value to be accepted, got ["Expected type 'int'. Found 'mixed'. [P1006]"]
phpactor 2026.10.07.0Phpactor 2026.10.07.0 Not enforced

No diagnostics reported.

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

No diagnostics reported.

  • Recognition: spelling resolved
  • Enforcement: 0/1 of the expected violations reported
qodana 262.10968.76PhpStorm 262.10968.76 Not enforced

No diagnostics reported.

  • Recognition: spelling resolved
  • Enforcement: 0/1 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
phpdoc_advanced_vendor_prefixed_assert_phan.php:37: not null safety call in function Conformance\Tests\PhpdocAdvancedVendorPrefixedAssertPhan\takesInt signature of param value [notNullSafetyFunctionArgumentVariable]
  • Recognition: spelling resolved
  • Enforcement: 0/1 of the expected violations reported
Expectation diff
Line 37: Expected valid value to be accepted, got ["not null safety call in function Conformance\\Tests\\PhpdocAdvancedVendorPrefixedAssertPhan\\takesInt signature of param value [notNullSafetyFunctionArgumentVariable]"]
steins 0.1.8steins 0.1.8 (2026-09-21 revision 76306a9) Not enforced

No diagnostics reported.

  • Recognition: spelling resolved
  • Enforcement: 0/1 of the expected violations reported
phpstan-strict 2.3.1PHPStan - PHP Static Analysis Tool 2.3.1 Enforced
phpdoc_advanced_vendor_prefixed_assert_phan.php:43: Call to function is_string() with int will always evaluate to false.
  • Recognition: spelling resolved
  • Enforcement: 1/1 of the expected violations reported
psalm-next 7.0.0-rc2Psalm 7.0.0-rc2@20339e3fe5b8d03bcd8061030eb2a83ad50e5783 Enforced
phpdoc_advanced_vendor_prefixed_assert_phan.php:37: Argument 1 of Conformance\Tests\PhpdocAdvancedVendorPrefixedAssertPhan\takesInt cannot be mixed, expecting int [MixedArgument]
phpdoc_advanced_vendor_prefixed_assert_phan.php:43: Type int for $value is never string [TypeDoesNotContainType]
phpdoc_advanced_vendor_prefixed_assert_phan.php:43: Type int for $value is never string [RedundantCondition]
  • Recognition: spelling resolved
  • Enforcement: 1/1 of the expected violations reported
Expectation diff
Line 37: Expected valid value to be accepted, got ["Argument 1 of Conformance\\Tests\\PhpdocAdvancedVendorPrefixedAssertPhan\\takesInt cannot be mixed, expecting int [MixedArgument]"]

Source

<?php

declare(strict_types=1);

namespace Conformance\Tests\PhpdocAdvancedVendorPrefixedAssertPhan;

/**
 * Cross-tool handling of `@phan-assert`.
 *
 * Phan's unconditional assertion tag, parallel to `@psalm-assert` /
 * `@phpstan-assert`. After the call, supporting tools treat the argument as
 * the asserted type.
 *
 * References:
 * - Phan Annotating-Your-Source-Code-V6.md: `@phan-assert`
 * - Psalm adding_assertions.md / PHPStan narrowing-types.md
 */

/**
 * @phan-assert int $value
 */
function assertIsInt(mixed $value): void // T: @phan-assert
{
    if (!\is_int($value)) {
        throw new \InvalidArgumentException('not an int');
    }
}

function takesInt(int $value): void
{
}

function example(mixed $value): void
{
    assertIsInt($value);

    takesInt($value); // V

    // Applying the assertion makes $value an int, so an is_string() branch is
    // provably dead. A tool that ignores the tag keeps `mixed`, where
    // is_string() is a live check and nothing is reported — so the diagnostic
    // is emitted only by a tool that actually honoured @phan-assert.
    echo \is_string($value) ? 'string' : 'int'; // E?: after @phan-assert int, is_string() is always false
}