VS Code对PHP子类继承父类方法链式调用误报未定义方法

问题原因 #

父类setAgent、setReport方法的返回类型声明为self，VS Code中的PHP静态分析工具（如Intelephense）会静态解析这些方法返回BaseClass实例，而BaseClass没有process方法，因此触发误报。但实际运行时，$this指向的是子类ChildClass实例，代码可正常执行。

修复方案 #

方案1：使用static返回类型（PHP 8.0+推荐） #

将父类中两个set方法的返回类型从self改为static，利用PHP的后期静态绑定特性，让静态分析工具识别到方法返回的是实际调用的子类实例：

class BaseClass
{
    protected $agent;
    protected $report;

    public function __construct() {}

    public function setAgent($agent) : static
    {
        $this->agent = $agent;
        return $this;
    }

    public function setReport($report) : static
    {
        $this->report = $report;
        return $this;
    }

    public function getAgent() : User
    {
        return $this->agent;
    }

    public function getReport()
    {
        return $this->report;
    }
}

方案2：添加PHPDoc注释（兼容PHP 7.x及以下） #

如果项目使用较低版本PHP，不支持static返回类型，可以给父类的set方法添加@return static的PHPDoc注释，明确告知静态分析工具返回的是当前调用类的实例：

class BaseClass
{
    protected $agent;
    protected $report;

    public function __construct() {}

    /** @return static */
    public function setAgent($agent) : self
    {
        $this->agent = $agent;
        return $this;
    }

    /** @return static */
    public function setReport($report) : self
    {
        $this->report = $report;
        return $this;
    }

    public function getAgent() : User
    {
        return $this->agent;
    }

    public function getReport()
    {
        return $this->report;
    }
}

方案3：在调用处添加类型断言 #

如果不想修改父类代码，可以在调用实例的地方添加PHPDoc类型注释，明确指定变量的子类类型：

/** @var ChildClass $child */
$child = new ChildClass();
$child->setAgent($this->user)
      ->setReport($this->report)
      ->process($status);

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