← 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.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/1 of the expected violations reported
phpstan 2.2.8PHPStan - PHP Static Analysis Tool 2.2.8 Not enforced reported Lv.4+
phpdoc_advanced_vendor_prefixed_assert_phan.php:37: Call to function is_string() with int will always evaluate to false. [identifier=function.impossibleType] [reported-from-level=4]
With strict-rules
phpdoc_advanced_vendor_prefixed_assert_phan.php:37: Call to function is_string() with int will always evaluate to false. [identifier=function.impossibleType]
  • Recognition: spelling resolved
  • Enforcement: 0/1 of the expected violations reported
Expectation diff
Line 37: Expected valid value to be accepted, got ["Call to function is_string() with int will always evaluate to false. [identifier=function.impossibleType] [reported-from-level=4]"]
psalm 6.16.1Psalm 6.16.1@f1f5de594dc76faf8784e02d3dc4716c91c6f6ac
next: 7.0.0-beta19
Not enforced

No diagnostics reported.

  • Recognition: spelling resolved
  • Enforcement: 0/1 of the expected violations reported
mago 1.46.0mago 1.46.0 Not enforced
phpdoc_advanced_vendor_prefixed_assert_phan.php:37: Impossible type assertion: `$value` of type `int` can never be `string`. [impossible-type-comparison]
phpdoc_advanced_vendor_prefixed_assert_phan.php:37: Redundant ternary operator: condition is always falsy. [impossible-condition]
  • Recognition: spelling resolved
  • Enforcement: 0/1 of the expected violations reported
Expectation diff
Line 37: Expected valid value to be accepted, got ["Impossible type assertion: `$value` of type `int` can never be `string`. [impossible-type-comparison]","Redundant ternary operator: condition is always falsy. [impossible-condition]"]
mir 0.70.1mir 0.70.1 Not enforced

No diagnostics reported.

  • Recognition: spelling resolved
  • Enforcement: 0/1 of the expected violations reported
phpantom 0.9.0phpantom_lsp 0.9.0 Not enforced

No diagnostics reported.

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

No diagnostics reported.

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

No diagnostics reported.

  • Recognition: spelling resolved
  • Enforcement: 0/1 of the expected violations reported
qodana 262.8665.325Qodana 262.8665.325 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

No diagnostics reported.

  • Recognition: spelling resolved
  • Enforcement: 0/1 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/1 of the expected violations reported
phpstan-strict 2.2.8PHPStan - PHP Static Analysis Tool 2.2.8 Not enforced
phpdoc_advanced_vendor_prefixed_assert_phan.php:37: Call to function is_string() with int will always evaluate to false. [identifier=function.impossibleType]
  • Recognition: spelling resolved
  • Enforcement: 0/1 of the expected violations reported
Expectation diff
Line 37: Expected valid value to be accepted, got ["Call to function is_string() with int will always evaluate to false. [identifier=function.impossibleType]"]
psalm-next 7.0.0-beta19Psalm 7.0.0-beta19@7e751c06a756fa64dc4c759c09fe4a173afcb433 Not enforced

No diagnostics reported.

  • Recognition: spelling resolved
  • Enforcement: 0/1 of the expected violations reported

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
}