@phpstan-assert@param tag it changes what the *caller* knows,
so ignoring it is silent: nothing is rejected, a narrowing simply does not
happen. The probe is a check that only becomes impossible once the assertion
has been applied.
References:
- PHPStan phpdocs-basics: @phpstan-assert
- Psalm adding_assertions.md| Analyzer | Version | Result | Diagnostics |
|---|---|---|---|
| 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.
|
| phpstan | 2.2.8PHPStan - PHP Static Analysis Tool 2.2.8 | Not enforced reported Lv.4+ | phpdoc_advanced_vendor_prefixed_assert_phpstan.php:37: Call to function is_string() with int will always evaluate to false. [identifier=function.impossibleType] [reported-from-level=4] With strict-rulesphpdoc_advanced_vendor_prefixed_assert_phpstan.php:37: Call to function is_string() with int will always evaluate to false. [identifier=function.impossibleType]
Expectation diffLine 37: Unexpected errors ["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 (pzoom≠) | phpdoc_advanced_vendor_prefixed_assert_phpstan.php:37: Docblock-defined type int for $value is never string [DocblockTypeContradiction] phpdoc_advanced_vendor_prefixed_assert_phpstan.php:37: Docblock-defined type int for $value is never string [RedundantConditionGivenDocblockType] pzoom (Psalm port)No diagnostics from pzoom.
Expectation diffLine 37: Unexpected errors ["Docblock-defined type int for $value is never string [DocblockTypeContradiction]","Docblock-defined type int for $value is never string [RedundantConditionGivenDocblockType]"] |
| mago | 1.46.0mago 1.46.0 | Not enforced ⚠ 1 false positive | phpdoc_advanced_vendor_prefixed_assert_phpstan.php:37: Impossible type assertion: `$value` of type `int` can never be `string`. [impossible-type-comparison] phpdoc_advanced_vendor_prefixed_assert_phpstan.php:37: Redundant ternary operator: condition is always falsy. [impossible-condition]
Expectation diffLine 37: Unexpected errors ["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.
|
| phpantom | 0.9.0phpantom_lsp 0.9.0 | Not enforced | No diagnostics reported.
|
| intelephense | 1.18.5intelephense 1.18.5 | Not enforced | No diagnostics reported.
|
| phpy | 0.2.0phpy 0.2.0 | Not enforced | No diagnostics reported.
|
| qodana | 262.8665.325Qodana 262.8665.325 | Not enforced | No diagnostics 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.
|
| steins | 0.1.5steins 0.1.5 (2026-08-12 revision 39b4cc1) | Not enforced | No diagnostics reported.
|
| phpstan-strict | 2.2.8PHPStan - PHP Static Analysis Tool 2.2.8 | Not enforced ⚠ 1 false positive | phpdoc_advanced_vendor_prefixed_assert_phpstan.php:37: Call to function is_string() with int will always evaluate to false. [identifier=function.impossibleType]
Expectation diffLine 37: Unexpected errors ["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 ⚠ 1 false positive | phpdoc_advanced_vendor_prefixed_assert_phpstan.php:37: Docblock-defined type int for $value is never string [DocblockTypeContradiction] phpdoc_advanced_vendor_prefixed_assert_phpstan.php:37: Docblock-defined type int for $value is never string [RedundantConditionGivenDocblockType]
Expectation diffLine 37: Unexpected errors ["Docblock-defined type int for $value is never string [DocblockTypeContradiction]","Docblock-defined type int for $value is never string [RedundantConditionGivenDocblockType]"] |
<?php
declare(strict_types=1);
namespace Conformance\Tests\PhpdocAdvancedVendorPrefixedAssertPhpStan;
/**
* Cross-tool handling of `@phpstan-assert`
*
* The tag says that a call to this function guarantees the type of an argument
* from that point on. Unlike a `@param` tag it changes what the *caller* knows,
* so ignoring it is silent: nothing is rejected, a narrowing simply does not
* happen. The probe is a check that only becomes impossible once the assertion
* has been applied.
*
* References:
* - PHPStan phpdocs-basics: @phpstan-assert
* - Psalm adding_assertions.md
*/
/**
* @phpstan-assert int $value
*/
function assertIsInt(mixed $value): void // T: @phpstan-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 this test can never be
// true. Ignoring the tag leaves `mixed`, where it is an ordinary check.
echo \is_string($value) ? 'string' : 'int'; // E?: after @phpstan-assert int, is_string() is always false
}