PhpStorm方法链+多类场景下智能提示失效求助

代码结构 #

trait ContextTrait
{
    public Subscriptions $subscription;
    
    public function setSubscription(Subscriptions $value): self 
    {
        $this->subscription = $value;
        
        return $this;
    }
}

abstract class Transaction
{
    use ContextTrait;
    
    protected ?int $paymentMethodId = null;
    
    public function setPaymentMethodId(?int $value): self 
    {
        $this->paymentMethodId = $value;

        return $this;
    }
}

class Invoice extends Transaction
{
    protected ?string $dueDate = null;
    
    public function setDueDate(?string $value): self
    {
        $this->dueDate = $value;
        
        return $this;
    }
}

问题场景 #

使用链式初始化类时：

$invoice = (new Invoice)
    ->setSubscription(...)
    ->setPaymentMethodId(...)
    ->setDueDate(...);

出现以下问题：

• 输入时智能提示仅对->setSubscription和->setPaymentMethodId生效，无法识别->setDueDate；
• 按F12跳转->setDueDate时提示“无法找到要跳转的声明”；
• 类中的setDueDate函数被标灰，提示“从未在任何地方使用”。

采用非链式实例化方式时，所有功能均正常：

$invoice = new Invoice;
$invoice->setSubscription(...);
$invoice->setPaymentMethodId(...);
$invoice->setDueDate(...);

补充说明：

• 链式调用时，无法显示->setDueDate函数；
• 非链式调用时，可正常显示->setDueDate函数。

解决办法 #

问题根源在于父类和trait中的set方法返回类型为self，PhpStorm静态分析无法自动推断子类链式调用后的实际类型，可通过以下方式修复：

方法1：修改返回类型为static（推荐） #

将所有set方法的返回类型从self改为static（PHP 7.0+支持），static会返回当前调用对象的实际类型，适配继承场景的链式调用：

trait ContextTrait
{
    public Subscriptions $subscription;
    
    public function setSubscription(Subscriptions $value): static 
    {
        $this->subscription = $value;
        
        return $this;
    }
}

abstract class Transaction
{
    use ContextTrait;
    
    protected ?int $paymentMethodId = null;
    
    public function setPaymentMethodId(?int $value): static 
    {
        $this->paymentMethodId = $value;

        return $this;
    }
}

class Invoice extends Transaction
{
    protected ?string $dueDate = null;
    
    public function setDueDate(?string $value): static
    {
        $this->dueDate = $value;
        
        return $this;
    }
}

方法2：添加类型注释临时修复 #

如果不想修改代码，可在链式调用前显式指定变量类型：

/** @var Invoice $invoice */
$invoice = (new Invoice)
    ->setSubscription(...)
    ->setPaymentMethodId(...)
    ->setDueDate(...);

方法3：清除IDE缓存 #

若以上方法无效，可能是缓存问题：

• 打开PhpStorm的File菜单，选择Invalidate Caches...；
• 勾选Clear file system cache and local history，点击Invalidate and Restart。

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