Maelstromeous / ps2alerts-api

src/Transformer/AlertTransformer.php

Doc Comments +11 added lines, -11 removed lines

@@ -132,7 +132,7 @@ 
      *
      * @param  array $data
      *
-     * @return League\Fractal\Resource\Collection
+     * @return \League\Fractal\Resource\Collection
      */
     public function includeClasses($data)
     {
@@ -145,7 +145,7 @@ 
      *
      * @param  array $data
      *
-     * @return League\Fractal\Resource\Collection
+     * @return \League\Fractal\Resource\Collection
      */
     public function includeCombatHistorys($data)
     {
@@ -158,7 +158,7 @@ 
      *
      * @param  array $data
      *
-     * @return League\Fractal\Resource\Collection
+     * @return \League\Fractal\Resource\Item
      */
     public function includeFactions($data)
     {
@@ -171,7 +171,7 @@ 
      *
      * @param  array $data
      *
-     * @return League\Fractal\Resource\Collection
+     * @return \League\Fractal\Resource\Collection
      */
     public function includeMapInitials($data)
     {
@@ -184,7 +184,7 @@ 
      *
      * @param  array $data
      *
-     * @return League\Fractal\Resource\Collection
+     * @return \League\Fractal\Resource\Collection
      */
     public function includeMaps($data)
     {
@@ -197,7 +197,7 @@ 
      *
      * @param  array $data
      *
-     * @return League\Fractal\Resource\Collection
+     * @return \League\Fractal\Resource\Collection
      */
     public function includeOutfits($data)
     {
@@ -210,7 +210,7 @@ 
      *
      * @param  array $data
      *
-     * @return League\Fractal\Resource\Collection
+     * @return \League\Fractal\Resource\Collection
      */
     public function includePopulations($data)
     {
@@ -223,7 +223,7 @@ 
      *
      * @param  array $data
      *
-     * @return League\Fractal\Resource\Collection
+     * @return \League\Fractal\Resource\Collection
      */
     public function includePlayers($data)
     {
@@ -236,7 +236,7 @@ 
      *
      * @param  array $data
      *
-     * @return League\Fractal\Resource\Collection
+     * @return \League\Fractal\Resource\Collection
      */
     public function includeVehicles($data)
     {
@@ -249,7 +249,7 @@ 
      *
      * @param  array $data
      *
-     * @return League\Fractal\Resource\Collection
+     * @return \League\Fractal\Resource\Collection
      */
     public function includeWeapons($data)
     {
@@ -262,7 +262,7 @@ 
      *
      * @param  array $data
      *
-     * @return League\Fractal\Resource\Collection
+     * @return \League\Fractal\Resource\Collection
      */
     public function includeXps($data)
     {

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 $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')
     {
@@ -264,7 +264,7 @@ 
     /**
      * Reads any requested includes and adds them to the item / collection
      *
-     * @param  Symfony\Component\HttpFoundation\Request $request
+     * @param  Request $request
      *
      * @return void
      */

src/Controller/Endpoint/AlertEndpointController.php

Doc Comments +12 added lines, -13 removed lines

@@ -15,9 +15,9 @@ 
     /**
      * Construct
      *
-     * @param Ps2alerts\Api\Repository\AlertRepository   $repository
-     * @param Ps2alerts\Api\Transformer\AlertTransformer $transformer
-     * @param League\Fractal\Manager                     $fractal
+     * @param AlertRepository   $repository
+     * @param AlertTransformer $transformer
+     * @param Manager                     $fractal
      */
     public function __construct(
         AlertRepository  $repository,
@@ -34,11 +34,11 @@ 
      *
      * @see AbstractEndpointController::respondWithItem
      *
-     * @param  Symfony\Component\HttpFoundation\Request  $request
-     * @param  Symfony\Component\HttpFoundation\Response $response
+     * @param  Request  $request
+     * @param  Response $response
      * @param  array                                     $args
      *
-     * @return array
+     * @return Response
      */
     public function getSingle(Request $request, Response $response, array $args)
     {
@@ -65,11 +65,10 @@ 
     /**
      * Returns the victories of each faction and the totals
      *
-     * @param  Symfony\Component\HttpFoundation\Request  $request
-     * @param  Symfony\Component\HttpFoundation\Response $response
-     * @param  array                                     $args
+     * @param  Request  $request
+     * @param  Response $response
      *
-     * @return array
+     * @return Response
      */
     public function getVictories(Request $request, Response $response)
     {
@@ -91,10 +90,10 @@ 
     /**
      * Returns the dominations of each faction and the totals
      *
-     * @param  Symfony\Component\HttpFoundation\Request  $request
-     * @param  Symfony\Component\HttpFoundation\Response $response
+     * @param  Request  $request
+     * @param  Response $response
      *
-     * @return array
+     * @return Response
      */
     public function getDominations(Request $request, Response $response)
     {

src/Repository/AbstractEndpointRepository.php

Doc Comments +1 added lines, -3 removed lines

@@ -116,7 +116,6 @@ 
      * Reads all records based off a simple where statement
      *
      * @param  array $fields
-     * @param  string $value
      *
      * @return array
      */
@@ -136,8 +135,7 @@ 
     /**
      * Reads the count of records based off a where statement
      *
-     * @param  array $field
-     * @param  string $value
+     * @param  array $fields
      *
      * @return array
      */