具有基於方法類型的必需參數的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方法需要哪些屬性。