在 PHPDoc 标准中键入提示水合对象

Question

我正在使用 Doctrine 获取实体，并使用它来将结果合并为数组。问题是，我不确定如何为这种返回创建注释：

@return annotation of method \App\Repository\UserRepository::findOneByIdAsArray() does not specify type hint for items of its traversable return value.

我应该如何用很多类型注释返回数组？

我可以使用这样的东西：

/**
 * @return (string|int|bool)[]
 */

但是如果源实体对象发生变化（UserEntity），这个注解就不会正确了。

我也可以这样做：

/**
 * @return UserEntity[]
 */

但我认为它不正确，因为我不是返回对象本身，而是返回它们值的数组版本。

我应该如何进行？

Answer 1

用 | 分隔多个类型最后使用 [] 来指定它是一个数组。

类似：

/**
 * @return string|int|bool|UserEntity[]
 */

最好使用 UserEntity 的全名。

/**
 * @return string|int|bool|\My\Namespace\UserEntity[]
 */