PhpStorm：处理“返回值预计为......”警告的最佳方法是什么？

Question

我的 PHP 代码结构如下（这种结构是不可更改的）：

class BaseFooClass {
}

class ChildFooClass1 extends BaseFooClass {
}

class ChildFooClass2 extends BaseFooClass {
}

//... (there are like a hundred child foo classes)

class BaseBarClass {
    protected function getFooBase($input) : BaseFooClass 
    {
        $class = "ChildFooClass" . $input;
        return new $class();
    }
}

class ChildBarClass1 extends BaseBarClass {
    public function getFoo() : ChildFooClass1 
    {
        return $this->getFooBase(1);
    }
}

现在在ChildBarClass1 中的getFoo() 函数中，PhpStorm 将给出警告“返回值预计为 'ChildFooClass1'，'BaseFooClass' 返回”并且它正确地这样做了。

但是我想要一个干净的代码，没有警告而不改变这个结构。

我通过添加 PHP doc 尝试了以下操作：

    public function getFoo() : ChildFooClass1 
    {
        /** @var ChildFooClass1 $foo **/
        $foo = $this->getFooBase(1);
        return $foo;
    }

但是这次它给出了一个不同的警告“不必要的局部变量”并要求我将其内联。

有没有消除警告的好方法？

编辑：也尝试了以下方法，但仍然出现“预期返回值...”的警告。

    /**
     * @return ChildFooClass1
     */
    public function getFoo() : ChildFooClass1 
    {
        return $this->getFooBase(1);
    }

Answer 1

假设您的代码 BaseBarClass::getFooBase() 返回 BaseFooClass 而 ChildBarClass1::getFoo() 想要返回 ChildFooClass1。

这违反了 php 的 Covariance/Contravariance 规则，根据该规则，您只能返回更具体的类型而不是更通用的类型，PhpStorm 会正确地警告您。

因此，您可以遵守此规则 (good) 并重构代码或抑制错误 (bad)。

例如：

// corrected type:
class ChildBarClass1 extends BaseBarClass
{
    public function getFoo(): BaseFooClass
    {
        return $this->getFooBase(1);
    }
}

// error suppressed:
class ChildBarClass1 extends BaseBarClass
{
    public function getFoo(): ChildFooClass1
    {
        /** @noinspection PhpIncompatibleReturnTypeInspection */
        return $this->getFooBase(1);
    }
}