使用延迟加载的phpdoc @return

Question

我不知道如何记录我的自动补全方法。

我的模型训练有一个getAnimators()方法，它返回一个实现SeekableIterator和Countable的Db_MysqlResult。当我在此Db_MysqlResult上迭代时，它将创建我的动画对象，例如：

<?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行识别为类型提示，并使用它为您提供自动完成功能。

但是，我不知道有哪种集成开发环境能够识别$training->getAnimators()的返回值，并根据它们在foreach()中绑定在一起来自动识别$animator的类型。