PhpStorm如何覆写explode函数返回类型解决EA插件检查报错

问题说明 #

• PHP 8.0对explode函数的返回类型做了调整，异常场景下不再返回false，固定返回数组类型；但PHP 7.2-7.4版本中，explode在传入空分隔符等异常场景下会返回false，因此原生签名标注返回类型为array|false。
• 使用PhpStorm 2022.1.3 + Php Inspections (EA Extended) 4.0.7.1插件，将代码检查级别设置为PHP 7.2时，会对explode返回值的数组偏移访问抛出如下提示：

[EA] 变量可能不支持偏移操作（或其类型未正确标注，类型为：[bool, array]）。

• 触发报错的典型代码如下，PHP 8.0环境下检查无报错，7.x环境下$gps[0]、$gps[1]位置会触发提示：

$gps = explode(',', $result['GPS']);
if (count($gps) == 2) {
    $items['lat'] = $gps[0];
    $items['lng'] = $gps[1];
}

• 此前尝试新增*.phpstorm.meta.php/explode.php*文件覆写类型但未生效，原配置代码如下：

<?php
namespace PHPSTORM_META {
    override( explode,
        function explode(string $separator, string $string, int $limit): array {
            return [];
        }
    );
}

解决方法 #

方法1：修正PhpStorm meta文件配置（全局生效，推荐） #

原配置不生效有两个原因：一是override第一个参数需要传入字符串格式的函数名，不能直接传函数名常量；二是不需要在配置内写完整的函数实现，通过map方法映射返回类型即可。正确配置代码如下：

<?php
namespace PHPSTORM_META {
    // 覆写explode返回类型固定为数组
    override('explode', map([
        '' => array[],
    ]));
}

将该文件放在项目根目录的.phpstorm.meta.php目录下，重建PhpStorm索引后即可生效，所有explode调用的返回值会被固定推断为数组，不会再触发bool相关的偏移报错。

方法2：局部加类型断言（无需全局配置） #

如果不想修改全局类型定义，可以在每处explode调用后加类型断言，断言在生产环境可通过配置关闭，不影响运行时逻辑，同时能让IDE正确推断类型：

$gps = explode(',', $result['GPS']);
assert(is_array($gps));
if (count($gps) == 2) {
    $items['lat'] = $gps[0];
    $items['lng'] = $gps[1];
}

方法3：调整EA插件检查规则 #

进入PhpStorm设置 -> Editor -> Inspections，找到Php Inspections (EA Extended)下的Type consistency -> Offset operations possibly not supported规则，可以将bool类型从检查范围中移除，或者添加explode返回值的例外规则。这种方式会降低其他场景下的检查严格度，不推荐优先使用。

内容的提问来源于stack exchange，提问作者luigifab