php - PHPDoc 中的闭包语法

Question

我在 PHPDoc 中找不到任何关于闭包类型的文档。所以我的问题是如何定义发送到闭包的参数的参数及其返回值？

例子:

我如何描述“回调”将获得一个“MyCustomClass”、一个数字和一个字符串，并返回一个“MyOtherCustomClass”？

/**
 * @param MyCustomClass $cls
 * @param Closure       $callback this isn't really explaining what this is
 *
 * @return MyOtherCustomClass
 */
function changer($cls, $callback){

  return $callback($cls, 2, "a string");
}

changer($aCustomeClass, function($cls, $int, $string){
   return new MyOtherCustomClass($cls, $int, $string);
})

或者如果可能的话？

Answer 1

@param callable $callback 确实是用于该部分的语法。您没有将该参数限制为闭包本身……传递给它的任何可调用对象都将在该实现中被接受。 Callable 是合法的“PHP 类型”，因此 phpDocumentor 接受它作为有效类型。

在您的示例代码中，实际上没有有理由假定您的changer() 方法返回MyOtherCustomClass()，因为那完全取决于您稍后在 changer() 用法中如何编写闭包。充其量，您可以在 changer() 用法中指出 changer() 的这种特殊用法 em> 返回 MyOtherCustomClass，因为返回特定类型对象的是该用法的实现，而不是 changer() 实现本身。

至于记录传递的可调用对象“需要”接受的参数，我想您必须在 param 标记的描述部分中这样做。没有语法来描述这种情况。

如果我要以这种方式实现某些东西，我会强加一个接口(interface)，所有可调用对象都必须显式返回该接口(interface)，因此我可以编写 changer() 返回该接口(interface)。当然，这意味着您的 MyOtherCustomClass 必须实现该接口(interface)，但在我看来，这仍然是接近“强制”从 changer()< 返回类型的唯一方法.