具有基于方法类型所需参数的 Restler 类

Question

假设我将它与我的 API 类一起使用

class EventInfo {
    /// @var int $start The Start time
    public $start

    /// @var string $url The URL for the event {@required false}
    public $url = null;
}

现在我想将EventInfo 用于我的 POST 和 PATCH 方法。当我进行 POST 时，$start 是需要设置的属性。 $url 将作为可选参数出现。

但是，当我执行 PATCH 操作时，应该不再需要 $start。我可能会过了一个新的开始时间，但我可能不会。

如何指定？

Answer 1

首先，使用 DocBlock 语法

class EventInfo {
    /**
     * @var int $start The Start time
     */
    public $start;

    /**
     * @var string $url The URL for the event {@required false}
     */
    public $url = null;
}

这会设置默认的必需和可选属性。然后，您可以使用{@required } 注释在 api 方法级别控制所需的属性。请参阅下面的示例

class Home
{
    public function index()
    {
        return array(
            'success' => array(
                'code' => 200,
                'message' => 'Restler is up and running!',
            ),
        );
    }

    public function patch(EventInfo $info)
    {
        return func_get_args();
    }

    /**
     * @param EventInfo $info {@required start,url}
     * @return array
     */
    public function post(EventInfo $info)
    {
        return func_get_args();
    }
}

您也可以类似地添加{@properties start} 注释以限制API 方法需要哪些属性。