Fix phpdoc in Handler

This commit is contained in:
PJ Dietz 2014-07-13 09:22:13 -04:00
parent c61b2197ea
commit 3be61bfb07
2 changed files with 14 additions and 6 deletions

View File

@ -12,7 +12,7 @@
<target>docs</target> <target>docs</target>
</transformer> </transformer>
<transformations> <transformations>
<template name="responsive" /> <template name="clean" />
</transformations> </transformations>
<files> <files>
<directory>src</directory> <directory>src</directory>

View File

@ -19,11 +19,11 @@ use pjdietz\WellRESTed\Interfaces\RequestInterface;
* Responds to a request based on the HTTP method. * Responds to a request based on the HTTP method.
* *
* To use Handler, create a subclass and implement the methods for any HTTP * To use Handler, create a subclass and implement the methods for any HTTP
* verbs you would like to support. (get() for GET, post() for POST, etc). * verbs you would like to support. (`get()` for GET, `post()` for POST, etc).
* *
* - Access the request via the protected member $this->request * - Access the request via the protected member `$this->request`
* - Access a map of arguments via $this->args (e.g., URI path variables) * - Access a map of arguments via `$this->args` (e.g., URI path variables)
* - Modify $this->response to provide the response the instance will return * - Modify `$this->response` to provide the response the instance will return
*/ */
abstract class Handler implements HandlerInterface abstract class Handler implements HandlerInterface
{ {
@ -35,6 +35,8 @@ abstract class Handler implements HandlerInterface
protected $response; protected $response;
/** /**
* Return the handled response.
*
* @param RequestInterface $request * @param RequestInterface $request
* @param array|null $args * @param array|null $args
* @return ResponseInterface * @return ResponseInterface
@ -179,7 +181,13 @@ abstract class Handler implements HandlerInterface
$this->addAllowHeader(); $this->addAllowHeader();
} }
/** @return array of method names supported by the handler. */ /**
* Return an array of HTTP verbs this handler supports.
*
* For example, to support GET and POST, return array("GET","POST");
*
* @return array
*/
protected function getAllowedMethods() protected function getAllowedMethods()
{ {
} }