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

时间:2018-12-22 18:48:09

标签: php phpdoc

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

pip install numpy==1.14.3

我应该如何注释具有很多类型的return数组?

我可以使用类似这样的东西:

numpy

但是如果源实体对象发生更改(@return annotation of method \App\Repository\UserRepository::findOneByIdAsArray() does not specify type hint for items of its traversable return value. ),则此注释将不正确。

我也可以这样做:

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

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

我应该如何进行?

1 个答案:

答案 0 :(得分:0)

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

类似的东西:

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

最好为UserEntity使用完整的名称。

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