Question

想象一下以下假设的类结构，而不是一个非常罕见的场景，所有PHPdoc提示都设置正确：

class BaseFilter {
  /** ...base methods... */
}

class TextFilter extends BaseFilter {
  public function setMinLength($len)
  {
    /** ...irrelevant */
  }
}

class SomethingWithFilters
{
  /**
   * @param BaseFilter $filter A valid filter to be added.
   * @return BaseFilter The filter that was added for easy chaining
   */
  public function addFilter(BaseFilter $filter)
  {
    $this->filters[] = $filter;
    return $filter;
  }

  /** @var BaseFilter[] A list of filters */
  private $filters = [];
}

现在我按如下方式使用此代码：

$myClass = new SomethingWithFilters();
$myClass->addFilter(new TextFilter())->setMinLength(8);

在phpStorm中（可能大多数其他IDE，因为它有意义）第二行产生一个警告，说明BaseFilter不包含方法setMinLength。虽然绝对正确，但这是多态行为，充分利用PHP的后期绑定特性 - 在像C＃这样的语言中你必须明确地进行上传。因此我希望phpDoc语法在这里支持某种动态表示法，声明addFilter的返回类型与提供的$filter类型相同。

我尝试将其更改为：

@return $filter

但这仅仅显示为对BaseFilter的引用，并且被视为同样的，仍然会发出警告。

是否有任何标准化的方法来实现这种效果，至少通用IDE可以理解它？

Answer 1

如果您的@return on addFilter（）实际上列出了可以返回的所有可能的BaseFilter子项，那么IDE在这里可能做得最好的可能是：

@return BaseFilter|TextFilter|AnotherFilter

此可能触发IDE为所有可能的返回类提供所有可能的方法。这取决于使用的IDE是否知道如何识别这种可能的返回类型列表。显然，这会让你自己变得乏味，将这样的列表放在许多返回标签中。

我不知道任何IDE会单独查看您的返回类型的BaseFilter，生成所有可能的父+子方法的列表，从而使整个列表可用于自动完成自动。

phpDoc表示法指定与参数类型相同的返回类型

1 个答案: