30

我有一个接受回调作为参数的方法。我想在 PHPDoc 中为类方法提供一个签名，该签名概述了要传递给该方法的回调函数的参数，以便我的 IDE (PHPStorm) 可以为传递给我的方法的函数生成有效的类型提示，或者至少查看代码的人可以确定他们打算提供的回调的签名。

例如：

class Foo {
  public $items = [];
  /**
  * @param Callable(
  *   @param ArrayObject $items The list of items that bar() will return
  * ) $baz A callback to receive the items
  **/
  public function bar(Callable $baz) {
    $items = new ArrayObject($this->items);
    $baz($items);
  }
}

该方法bar有一个参数 ，$baz它是一个回调函数。任何作为参数传递给的函数都bar()必须接受一个ArrayObject作为其唯一参数。

理想情况下，应该可以为 包含多个参数Callable，就像任何其他方法一样。

当我编写以下代码时：

$foo = new Foo();
$foo->bar(function(

...然后我应该收到一个参数列表，该列表正确提示ArrayObject此函数调用的接受参数的类型 ()。

这样的事情可能吗？PHPStorm 或其他 IDE 是否支持它？即使没有 IDE 支持，是否有推荐/标准的记录方式？

4

3 回答 3

13

PHP 7+：

将可调用接口与匿名类结合使用就可以解决问题。它不是很方便，并且会导致类消费者的代码过于复杂，但目前它是静态代码分析方面的最佳解决方案。

/**
 * Interface MyCallableInterface
 */
interface MyCallableInterface{
    /**
     * @param Bar $bar
     *
     * @return Bar
     */
    public function __invoke(Bar $bar): Bar;
}

/**
 * Class Bar
 */
class Bar{
    /**
     * @var mixed
     */
    public $data = null;
}

/**
 * Class Foo
 */
class Foo{
    /**
     * @var Bar
     */
    private $bar = null;

    /**
     * @param MyCallableInterface $fn
     *
     * @return Foo
     */
    public function fooBar(MyCallableInterface $fn): Foo{
        $this->bar = $fn(new Bar);
        return $this;
    }
}

/**
 * Usage
 */
(new Foo)->fooBar(new class implements MyCallableInterface{
    public function __invoke(Bar $bar): Bar{
        $bar->data = [1, 2, 3];
        return $bar;
    }
});

如果您使用的是 PhpStorm，它甚至会__invoke在匿名类中自动生成 -Method 的签名和正文。

于 2017-03-16T08:09:14.407 回答
4

我通过static function在类中使用callable. 该函数有自己的文档块，我只是在需要使用 PHPDoc@see标记调用的方法中引用它。

class Foo
{
    /**
     * Description of the "bar" callable. Used by {@see baz()}.
     *
     * @param int $index A 1-based integer.
     * @param string $name A non-empty string.
     * @return bool
     * @see baz()
     * @throws \Exception This is a prototype; not meant to be called directly.
     */
    public static barCallable($index, $name)
    {
        throw new \Exception("barCallable prototype called");
    }

    /**
     * Description of the baz() method, using a {@see barCallable()}.
     *
     * @param callable $bar A non-null {@see barCallable()}.
     * @see barCallable()
     */
    public function baz(callable $bar)
    {
        // ...
        call_user_func($bar, 1, true);
        // ...
    }
}

这在 PhpStorm 10 中运行良好。快速文档允许轻松地从方法文档导航到原型文档。

我让我的原型函数抛出一个异常，以明确它不应该被调用。我可以使用 a protectedorprivate范围，但是 PHPDoc 不会总是选择 doc-block 来生成文档。

不幸的是，PhpStorm 无法跟踪回调的使用情况。使用需要回调的方法时，它也不提供参数信息，但至少正式记录了回调。

这种方法还有一个额外的好处，那就是在运行时根据原型的反射来验证回调定义。

于 2016-02-08T15:51:07.543 回答
3

目前在 PhpStorm 中是不可能的。我什至想不出通过其他方式做相对相同的其他解决方案。

于 2012-12-12T01:42:58.023 回答