Maelstromeous / ps2alerts-api

src/Command/LeaderboardPlayersCommand.php

Doc Comments +6 added lines

@@ -184,6 +184,9 @@ 
         }
     }
 
+    /**
+     * @param string $metric
+     */
     public function markAsBeingUpdated($metric, $server)
     {
         $key = "ps2alerts:api:leaderboards:status:{$server}";
@@ -205,6 +208,9 @@ 
         $this->redis->set($key, json_encode($data));
     }
 
+    /**
+     * @param string $metric
+     */
     public function markMetricAsComplete($metric, $server)
     {
         $key = "ps2alerts:api:leaderboards:status:{$server}";

src/Controller/Endpoint/Alerts/AlertCombatEndpointController.php

Doc Comments +7 added lines, -1 removed lines

@@ -24,7 +24,7 @@ 
      * Retrieves combat totals on a global and per-server basis
      * @param  ServerRequestInterface $request
      * @param  ResponseInterface      $response
-     * @return array
+     * @return ResponseInterface
      */
     public function getCombatTotals(ServerRequestInterface $request, ResponseInterface $response)
     {
@@ -250,6 +250,9 @@ 
         return $this->respondWithArray($results);
     }
 
+    /**
+     * @param integer $classID
+     */
     private function findClassGrouping($classID)
     {
         $classGroups = $this->getConfig()['classesGroups'];
@@ -265,6 +268,9 @@ 
         return false;
     }
 
+    /**
+     * @param integer $classID
+     */
     private function findClassFaction($classID)
     {
         $classesFactions = $this->getConfig()['classesFactions'];

src/Controller/Endpoint/Alerts/AlertCountsEndpointController.php

Doc Comments +7 added lines, -9 removed lines

@@ -16,9 +16,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,
@@ -33,10 +33,10 @@ 
     /**
      * Returns the victories of each faction and the totals
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface $response
      *
-     * @return array
+     * @return ResponseInterface
      */
     public function getVictories(ServerRequestInterface $request, ResponseInterface $response)
     {
@@ -49,7 +49,7 @@ 
      * @param  \Psr\Http\Message\ServerRequestInterface  $request
      * @param  \Psr\Http\Message\ResponseInterface $response
      *
-     * @return array
+     * @return ResponseInterface
      */
     public function getDominations(ServerRequestInterface $request, ResponseInterface $response)
     {
@@ -59,8 +59,6 @@ 
     /**
      * Gets the required count data and returns
      *
-     * @param  \Psr\Http\Message\ServerRequestInterface  $request
-     * @param  \Psr\Http\Message\ResponseInterface $response
      * @param  string                                     $mode     The type of data we're getting (victory / domination)
      *
      * @return \Psr\Http\Message\ResponseInterface

src/Controller/Endpoint/Alerts/AlertEndpointController.php

Doc Comments +15 added lines, -15 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,
@@ -32,11 +32,11 @@ 
     /**
      * Returns a single alert's information
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface  $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface  $response
      * @param  array                                     $args
      *
-     * @return \League\Fractal\TransformerAbstract
+     * @return ResponseInterface
      */
     public function getSingle(ServerRequestInterface $request, ResponseInterface $response, array $args)
     {
@@ -56,10 +56,10 @@ 
     /**
      * Returns all currently running alerts
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface $response
      *
-     * @return \League\Fractal\TransformerAbstract
+     * @return ResponseInterface
      */
     public function getActives(ServerRequestInterface $request, ResponseInterface $response)
     {
@@ -81,10 +81,10 @@ 
     /**
      * Returns all alerts in historial order
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface $response
      *
-     * @return \League\Fractal\TransformerAbstract
+     * @return ResponseInterface
      */
     public function getHistoryByDate(ServerRequestInterface $request, ResponseInterface $response)
     {
@@ -153,10 +153,10 @@ 
     /**
      * Returns all alerts by latest
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface $response
      *
-     * @return \League\Fractal\TransformerAbstract
+     * @return ResponseInterface
      */
     public function getLatest(ServerRequestInterface $request, ResponseInterface $response)
     {

src/Controller/Endpoint/ContextualDataEndpointController.php

Doc Comments +1 added lines, -3 removed lines

@@ -15,9 +15,7 @@
     /**
      * Construct
      *
-     * @param Ps2alerts\Api\Repository\AlertRepository   $repository
-     * @param Ps2alerts\Api\Transformer\AlertTransformer $transformer
-     * @param League\Fractal\Manager                     $fractal
+     * @param Manager                     $fractal
      */
     public function __construct(
         Manager          $fractal

src/Controller/Endpoint/Data/DataEndpointController.php

Doc Comments +10 added lines, -10 removed lines

@@ -25,7 +25,7 @@ 
     /**
      * Construct
      *
-     * @param League\Fractal\Manager                    $fractal
+     * @param Manager                    $fractal
      */
     public function __construct(
         Manager $fractal,
@@ -38,11 +38,11 @@ 
     /**
      * Gets supplemental data
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface $response
      * @param  array                                     $args
      *
-     * @return \League\Fractal\TransformerAbstract
+     * @return ResponseInterface
      */
     public function getSupplementalData(ServerRequestInterface $request, ResponseInterface $response, array $args)
     {
@@ -57,11 +57,11 @@ 
     /**
      * Gets a player's info, either from redis or db cache
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface $response
      * @param  array                                     $args
      *
-     * @return \League\Fractal\TransformerAbstract
+     * @return ResponseInterface
      */
     public function character(ServerRequestInterface $request, ResponseInterface $response, array $args)
     {
@@ -102,11 +102,11 @@ 
     /**
      * Gets an outfits's info, either from redis or db cache
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface $response
      * @param  array                                     $args
      *
-     * @return \League\Fractal\TransformerAbstract
+     * @return ResponseInterface
      */
     public function outfit(ServerRequestInterface $request, ResponseInterface $response, array $args)
     {

src/Controller/Endpoint/Leaderboards/LeaderboardLadderEndpointController.php

Doc Comments +6 added lines, -6 removed lines

@@ -29,10 +29,10 @@ 
     /**
      * Prompts the Leaderboard:Check command to resync the leaderboards
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface $response
      *
-     * @return Symfony\Component\HttpFoundation\Response
+     * @return ResponseInterface
      */
     public function update(ServerRequestInterface $request, ResponseInterface $response)
     {
@@ -71,10 +71,10 @@ 
     /**
      * Returns a list of times that a server leaderboard has been updated
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface $response
      *
-     * @return Symfony\Component\HttpFoundation\Response
+     * @return ResponseInterface
      */
     public function lastUpdate(ServerRequestInterface $request, ResponseInterface $response)
     {

src/Controller/Endpoint/Profiles/OutfitProfileEndpointController.php

Doc Comments +6 added lines, -6 removed lines

@@ -14,9 +14,9 @@ 
     /**
      * Construct
      *
-     * @param League\Fractal\Manager                                      $fractal
-     * @param Ps2alerts\Api\Repository\Metrics\OutfitTotalRepository      $outfitTotalRepo
-     * @param Ps2alerts\Api\Transformer\Profiles\OutfitProfileTransformer $outfitProfileTransformer
+     * @param Manager                                      $fractal
+     * @param OutfitTotalRepository      $outfitTotalRepo
+     * @param OutfitProfileTransformer $outfitProfileTransformer
      */
     public function __construct(
         Manager                  $fractal,
@@ -31,11 +31,11 @@ 
     /**
      * Gets a outfit
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface $response
      * @param  array                                     $args
      *
-     * @return array
+     * @return ResponseInterface
      */
     public function getOutfit(ServerRequestInterface $request, ResponseInterface $response, array $args)
     {

src/Controller/Endpoint/Profiles/PlayerProfileEndpointController.php

Doc Comments +6 added lines, -6 removed lines

@@ -14,9 +14,9 @@ 
     /**
      * Construct
      *
-     * @param League\Fractal\Manager                                      $fractal
-     * @param Ps2alerts\Api\Repository\Metrics\PlayerTotalRepository      $playerTotalRepo
-     * @param Ps2alerts\Api\Transformer\Profiles\PlayerProfileTransformer $playerProfileTransformer
+     * @param Manager                                      $fractal
+     * @param PlayerTotalRepository      $playerTotalRepo
+     * @param PlayerProfileTransformer $playerProfileTransformer
      */
     public function __construct(
         Manager                  $fractal,
@@ -31,11 +31,11 @@ 
     /**
      * Gets a player
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface $response
      * @param  array                                     $args
      *
-     * @return array
+     * @return ResponseInterface
      */
     public function getPlayer(ServerRequestInterface $request, ResponseInterface $response, array $args)
     {