Maelstromeous / ps2alerts-api

src/Controller/Endpoint/AbstractEndpointController.php

Doc Comments +11 added lines, -11 removed lines

@@ -101,10 +101,10 @@ 
      * Builds an item response in Fractal then hands off to the responder
      *
      * @param  array $item                                The item to transform
-     * @param  mixed $callback                            The Transformer to pass through to Fractal
+     * @param  \League\Fractal\TransformerAbstract $callback                            The Transformer to pass through to Fractal
      * @param  \Symfony\Component\HttpFoundation\Response The client's response
      *
-     * @return array
+     * @return Response
      */
     protected function respondWithItem($item, $callback, Response $response)
     {
@@ -118,10 +118,10 @@ 
      * Builds a collection of items from Fractal then hands off to the responder
      *
      * @param  array $collection                         The collection to transform
-     * @param  mixed $callback                           The Transformer to pass through to Fractal
+     * @param  \League\Fractal\TransformerAbstract $callback                           The Transformer to pass through to Fractal
      * @param  \Symfony\Component\HttpFoundation\Response The client's response
      *
-     * @return array
+     * @return Response
      */
     protected function respondWithCollection($collection, $callback, Response $response)
     {
@@ -156,7 +156,7 @@ 
      * @param  string                                      $message   Response message to put in the error
      * @param  int                                         $errorCode Error code to set
      *
-     * @return array
+     * @return Response
      */
     protected function respondWithError(Response $response, $message, $errorCode)
     {
@@ -183,7 +183,7 @@ 
      * @param  \Symfony\Component\HttpFoundation\Response $response
      * @param  string                                     $message
      *
-     * @return void
+     * @return Response
      */
     public function errorEmpty(Response $response, $message = 'No data / Empty')
     {
@@ -197,7 +197,7 @@ 
      * @param  \Symfony\Component\HttpFoundation\Response $response
      * @param  string                                     $message
      *
-     * @return void
+     * @return Response
      */
     public function errorForbidden(Response $response, $message = 'Forbidden')
     {
@@ -211,7 +211,7 @@ 
      * @param  \Symfony\Component\HttpFoundation\Response $response
      * @param  string                                     $message
      *
-     * @return void
+     * @return Response
      */
     public function errorInternalError(Response $response, $message = 'Internal Error')
     {
@@ -225,7 +225,7 @@ 
      * @param  \Symfony\Component\HttpFoundation\Response $response
      * @param  string                                     $message
      *
-     * @return void
+     * @return Response
      */
     public function errorNotFound(Response $response, $message = 'Resource Not Found')
     {
@@ -239,7 +239,7 @@ 
      * @param  \Symfony\Component\HttpFoundation\Response $response
      * @param  string                                     $message
      *
-     * @return void
+     * @return Response
      */
     public function errorUnauthorized(Response $response, $message = 'Unauthorized')
     {
@@ -250,7 +250,7 @@ 
     /**
      * Generates a Response with a 400 HTTP header and a given message.
      *
-     * @param \Symfony\Component\HttpFoundation\Response $Response
+     * @param \Symfony\Component\HttpFoundation\Response $response
      * @param string                                     $message
      *
      * @return \Symfony\Component\HttpFoundation\Response