← All results

Optional-key shapes stay list-compatible

Group: Cross-analyzer regressions · Category: regression · File: regressions_optional_key_shape_is_list.php

Analyzer results

regressions_optional_key_shape_is_list.php:28: Call to function array_is_list() with array{a?: string} will always evaluate to false. [identifier=function.impossibleType] [reported-from-level=4]
regressions_optional_key_shape_is_list.php:36: Call to function array_is_list() with array{a?: string} will always evaluate to false. [identifier=function.impossibleType] [reported-from-level=4]
regressions_optional_key_shape_is_list.php:36: Call to function assert() with false will always evaluate to false. [identifier=function.impossibleType] [reported-from-level=4]

regressions_optional_key_shape_is_list.php:28: Call to function array_is_list() with array{a?: string} will always evaluate to false. [identifier=function.impossibleType]
regressions_optional_key_shape_is_list.php:36: Call to function array_is_list() with array{a?: string} will always evaluate to false. [identifier=function.impossibleType]
regressions_optional_key_shape_is_list.php:36: Call to function assert() with false will always evaluate to false. [identifier=function.impossibleType]

regressions_optional_key_shape_is_list.php:28: Type array{a?: string} for $a is never list<mixed> [TypeDoesNotContainType]
regressions_optional_key_shape_is_list.php:36: Type array{a?: string} for $a is never list<mixed> [TypeDoesNotContainType]

Line 28: Expected 1 error(s)
Line 36: Expected 1 error(s)

regressions_optional_key_shape_is_list.php:26: param $a miss matched with phpdoc type <<array{a?: string}>> [funcParamTypeMissMatch]
regressions_optional_key_shape_is_list.php:34: param $a miss matched with phpdoc type <<array{a?: string}>> [funcParamTypeMissMatch]

regressions_optional_key_shape_is_list.php:28: Call to function array_is_list() with array{a?: string} will always evaluate to false. [identifier=function.impossibleType]
regressions_optional_key_shape_is_list.php:36: Call to function array_is_list() with array{a?: string} will always evaluate to false. [identifier=function.impossibleType]
regressions_optional_key_shape_is_list.php:36: Call to function assert() with false will always evaluate to false. [identifier=function.impossibleType]

regressions_optional_key_shape_is_list.php:28: Type array{a?: string} for $a is never list<mixed> [TypeDoesNotContainType]
regressions_optional_key_shape_is_list.php:36: Type array{a?: string} for $a is never list<mixed> [TypeDoesNotContainType]

Source

<?php

declare(strict_types=1);

namespace Conformance\Tests\RegressionsOptionalKeyShapeIsList;

/**
 * Optional-key shapes stay list-compatible.
 *
 * A shape whose only keys are optional (for example `array{a?: string}`) includes `[]`
 * as a valid value, and `array_is_list([]) === true`. So `array_is_list($a)` is
 * undecidable (maybe true), not "always false", and narrowing to a list is reachable.
 *
 * Several analyzers historically treated the optional string key as required and
 * collapsed the list check to "always false" / "impossible". Phan alone reports the
 * check as "maybe", which is the runtime-correct verdict.
 *
 * References:
 * - PHPStan  https://github.com/phpstan/phpstan/issues/14938  (fix: phpstan-src#6025)
 * - Psalm    https://github.com/vimeo/psalm/issues/11905      (open)
 * - Mago     https://github.com/carthage-software/mago/issues/2073 (fixed in 1.43)
 * - Cross-tool survey https://github.com/phpstan/phpstan/discussions/14939
 */

/** @param array{a?: string} $a */
function optionalStringKeyIsList(array $a): void // E<noverify>: NoVerify does not parse array shape syntax and flags the annotation itself, not the list narrowing
{
    if (array_is_list($a)) { // E<phpstan>: array{a?: string} admits [], so the check is maybe-true not always-false (#14938) // E<phpstan-strict>: same always-false verdict under strict rules // E<psalm>: TypeDoesNotContainType, reported as never list<mixed> (#11905) // E<mago>: impossible-type-comparison in 1.19, fixed in 1.43 (#2073)
        echo "reached at runtime when \$a === []\n";
    }
}

/** @param array{a?: string} $a */
function optionalStringKeyAssertList(array $a): void // E<noverify>: NoVerify does not parse array shape syntax and flags the annotation itself, not the list narrowing
{
    assert(array_is_list($a)); // E<phpstan>: assert collapses to always-false on the optional-key shape (#14938) // E<phpstan-strict>: same always-false verdict under strict rules // E<psalm>: TypeDoesNotContainType, reported as never list<mixed> (#11905) // E<mago>: impossible-type-comparison in 1.19, fixed in 1.43 (#2073)
}

optionalStringKeyIsList([]);
optionalStringKeyAssertList([]);