return - phpdoc @return 延迟加载

Question

我不知道如何记录我的自动完成方法。

我的模型 Training 有一个 getAnimators() 方法，该方法返回一个实现 SeekableIterator 和 Countable 的 Db_MysqlResult。当我对其进行迭代时，这个 Db_MysqlResult 将创建我的 Animator 对象，例如：

<?php
foreach ($training->getAnimators() as $animator) {
    // Autocompletion shows me next, seek, etc. not getName
    echo $animator->getName(); 
}
?>

我可以在我的 getAnimators() 中写@return Animators[]，即使它不是真的，因为它返回一个 Db_MysqlResult？

在此先感谢您的帮助。

Answer 1

如果你正在寻找你的 $animator 变量来自动完成它的方法，你最好的选择可能是在其中添加一个 @var 行提示：

/** @var Animator $animator */
echo $animator->

一些 IDE 能够将 @var 行识别为类型提示，并使用它为您提供自动完成功能。

但是，我不知道有任何 IDE 可以识别您的 $training->getAnimators() 的返回值并自动知道 $animator 的类型，只是因为它们在该 foreach() 中绑定在一起。