harryosmar / php-restful-api-response

src/Response.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -8,6 +8,7 @@ 
 
 namespace PhpRestfulApiResponse;
 
+use InvalidArgumentException;
 use League\Fractal\Manager;
 use League\Fractal\Pagination\Cursor;
 use League\Fractal\Resource\Collection;
@@ -15,7 +16,6 @@ 
 use League\Fractal\TransformerAbstract;
 use PhpRestfulApiResponse\Contracts\PhpRestfulApiResponse;
 use Zend\Diactoros\MessageTrait;
-use InvalidArgumentException;
 
 class Response implements PhpRestfulApiResponse
 {

Doc Comments +12 added lines, -12 removed lines

@@ -170,7 +170,7 @@ 
     }
 
     /**
-     * @param $data
+     * @param Tests\unit\Lib\Book $data
      * @param TransformerAbstract|callable $transformer
      * @param int $code
      * @param null $resourceKey
@@ -194,7 +194,7 @@ 
     }
 
     /**
-     * @param $data
+     * @param Tests\unit\Lib\Book[] $data
      * @param TransformerAbstract|callable $transformer
      * @param int $code
      * @param null $resourceKey
@@ -228,7 +228,7 @@ 
      * @param string|array $message
      * @param string $code
      * @param array  $headers
-     * @return mixed
+     * @return Response
      */
     public function withError($message, $code, array $headers = [])
     {
@@ -255,7 +255,7 @@ 
      *
      * @param string $message
      * @param array  $headers
-     * @return mixed
+     * @return Response
      */
     public function errorForbidden(string $message = '', array $headers = [])
     {
@@ -267,7 +267,7 @@ 
      *
      * @param string $message
      * @param array  $headers
-     * @return mixed
+     * @return Response
      */
     public function errorInternalError(string $message = '', array $headers = [])
     {
@@ -279,7 +279,7 @@ 
      *
      * @param string $message
      * @param array  $headers
-     * @return mixed
+     * @return Response
      */
     public function errorNotFound(string $message = '', array $headers = [])
     {
@@ -291,7 +291,7 @@ 
      *
      * @param string $message
      * @param array $headers
-     * @return mixed
+     * @return Response
      */
     public function errorUnauthorized(string $message = '', array $headers = [])
     {
@@ -303,7 +303,7 @@ 
      *
      * @param array $message
      * @param array $headers
-     * @return mixed
+     * @return Response
      */
     public function errorWrongArgs(array $message, array $headers = [])
     {
@@ -315,7 +315,7 @@ 
      *
      * @param string $message
      * @param array $headers
-     * @return mixed
+     * @return Response
      */
     public function errorGone(string $message = '', array $headers = [])
     {
@@ -327,7 +327,7 @@ 
      *
      * @param string $message
      * @param array $headers
-     * @return mixed
+     * @return Response
      */
     public function errorMethodNotAllowed(string $message = '', array $headers = [])
     {
@@ -339,7 +339,7 @@ 
      *
      * @param string $message
      * @param array $headers
-     * @return mixed
+     * @return Response
      */
     public function errorUnwillingToProcess(string $message = '', array $headers = [])
     {
@@ -351,7 +351,7 @@ 
      *
      * @param string $message
      * @param array $headers
-     * @return mixed
+     * @return Response
      */
     public function errorUnprocessable(string $message = '', array $headers = [])
     {

tests/unit/ResponseTest.php

Doc Comments +3 added lines

@@ -60,6 +60,9 @@
         $this->assertEquals('{"data":[{"title":"how to be a ninja","author":{"name":"harry","email":"harryosmarsitohang"},"year":2017,"price":100000},{"title":"how to be a mage","author":{"name":"harry","email":"harryosmarsitohang"},"year":2016,"price":500000},{"title":"how to be a samurai","author":{"name":"harry","email":"harryosmarsitohang"},"year":2000,"price":25000}]}', $response->getBody()->__toString());
     }
 
+    /**
+     * @param integer $code
+     */
     private function withError(Response $response, $code, $message = null)
     {
         $this->assertEquals($code, $response->getStatusCode());