harryosmar / php-restful-api-response

src/Response.php

Doc Comments +12 added lines, -12 removed lines

@@ -183,7 +183,7 @@ 
     }
 
     /**
-     * @param $data
+     * @param Tests\unit\Lib\Book $data
      * @param TransformerAbstract|callable $transformer
      * @param int $code
      * @param null $resourceKey
@@ -207,7 +207,7 @@ 
     }
 
     /**
-     * @param $data
+     * @param Tests\unit\Lib\Book[] $data
      * @param TransformerAbstract|callable $transformer
      * @param int $code
      * @param null $resourceKey
@@ -242,7 +242,7 @@ 
      * @param int $statusCode
      * @param int|string $errorCode
      * @param array  $headers
-     * @return mixed
+     * @return Response
      */
     public function withError($message, int $statusCode, $errorCode = null, array $headers = [])
     {
@@ -272,7 +272,7 @@ 
      * @param string $message
      * @param int|string $errorCode
      * @param array  $headers
-     * @return mixed
+     * @return Response
      */
     public function errorForbidden(string $message = '', $errorCode = null, array $headers = [])
     {
@@ -285,7 +285,7 @@ 
      * @param string $message
      * @param int|string $errorCode
      * @param array $headers
-     * @return mixed
+     * @return Response
      */
     public function errorInternalError(string $message = '', $errorCode = null, array $headers = [])
     {
@@ -298,7 +298,7 @@ 
      * @param string $message
      * @param int|string $errorCode
      * @param array  $headers
-     * @return mixed
+     * @return Response
      */
     public function errorNotFound(string $message = '', $errorCode = null, array $headers = [])
     {
@@ -311,7 +311,7 @@ 
      * @param string $message
      * @param int|string $errorCode
      * @param array $headers
-     * @return mixed
+     * @return Response
      */
     public function errorUnauthorized(string $message = '', $errorCode = null, array $headers = [])
     {
@@ -324,7 +324,7 @@ 
      * @param array $message
      * @param int|array $errorCode
      * @param array $headers
-     * @return mixed
+     * @return Response
      */
     public function errorWrongArgs(array $message, $errorCode = null, array $headers = [])
     {
@@ -337,7 +337,7 @@ 
      * @param string $message
      * @param int|string $errorCode
      * @param array $headers
-     * @return mixed
+     * @return Response
      */
     public function errorGone(string $message = '', $errorCode = null, array $headers = [])
     {
@@ -350,7 +350,7 @@ 
      * @param string $message
      * @param int|string $errorCode
      * @param array $headers
-     * @return mixed
+     * @return Response
      */
     public function errorMethodNotAllowed(string $message = '', $errorCode = null, array $headers = [])
     {
@@ -363,7 +363,7 @@ 
      * @param string $message
      * @param int|string $errorCode
      * @param array $headers
-     * @return mixed
+     * @return Response
      */
     public function errorUnwillingToProcess(string $message = '', $errorCode = null, array $headers = [])
     {
@@ -376,7 +376,7 @@ 
      * @param string $message
      * @param int|string $errorCode
      * @param array $headers
-     * @return mixed
+     * @return Response
      */
     public function errorUnprocessable(string $message = '', $errorCode = null, array $headers = [])
     {

tests/unit/ResponseTest.php

Doc Comments +10 added lines

@@ -302,6 +302,9 @@ 
         $this->run_setErrorCode($this->getMethodSetErrorCode(), "ERROR-CODE");
     }
 
+    /**
+     * @param integer $code
+     */
     private function run_setStatusCode(\ReflectionMethod $method, $code)
     {
         try {
@@ -315,6 +318,9 @@ 
         }
     }
 
+    /**
+     * @param string $code
+     */
     private function run_setErrorCode(\ReflectionMethod $method, $code)
     {
         $method->invokeArgs($this->response, [$code]);
@@ -338,6 +344,10 @@ 
     }
 
 
+    /**
+     * @param integer $code
+     * @param string $errorCode
+     */
     private function withError(Response $response, $code, $message = null, $errorCode = null)
     {
         $this->assertEquals($code, $response->getStatusCode());