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}";

Indentation +1 added lines, -1 removed lines

@@ -89,7 +89,7 @@
                     $query->cols(['*']);
                     $query->from('ws_players_total');
                     if ($server != 0) {
-                         $query->where("playerServer = ?", $server);
+                            $query->where("playerServer = ?", $server);
                     }
                     $query->orderBy([$metric.' DESC']);
                     $query->limit($limit);

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'];

Unused Use Statements -3 removed lines

@@ -2,11 +2,8 @@
 
 namespace Ps2alerts\Api\Controller\Endpoint\Alerts;
 
-use League\Fractal\Manager;
 use Ps2alerts\Api\Controller\Endpoint\Alerts\AlertEndpointController;
 use Ps2alerts\Api\Exception\InvalidArgumentException;
-use Ps2alerts\Api\Repository\Metrics\CombatRepository;
-use Ps2alerts\Api\Repository\Metrics\ClassRepository;
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Message\ResponseInterface;
 

Spacing +13 added lines, -13 removed lines

@@ -49,23 +49,23 @@ 
             $data = $this->checkRedis('api', 'combatTotals', "{$server}-data");
             $dataArchive = $this->checkRedis('api', 'combatTotals', "{$server}-dataArchive");
 
-            if (! $data || ! $dataArchive) {
+            if (!$data || !$dataArchive) {
                 $sums = [];
                 foreach ($metrics as $metric) {
                     foreach ($factions as $faction) {
-                        $dbMetric = $metric . strtoupper($faction); // e.g. killsVS
-                        $dataMetric = $metric . strtoupper($faction); // e.g. killsVS
+                        $dbMetric = $metric.strtoupper($faction); // e.g. killsVS
+                        $dataMetric = $metric.strtoupper($faction); // e.g. killsVS
 
                         // Handle teamkills inconsistency
                         if ($metric === 'teamkills') {
-                            $dbMetric = 'teamKills' . strtoupper($faction);
+                            $dbMetric = 'teamKills'.strtoupper($faction);
                         }
                         $sums[] = "SUM(factions.{$dbMetric}) AS $dataMetric";
                     }
 
                     // Totals
-                    $dbMetric = 'total' . ucfirst($metric); // e.g. killsVS
-                    $dataMetric = 'total' . ucfirst($metric); // e.g. killsVS
+                    $dbMetric = 'total'.ucfirst($metric); // e.g. killsVS
+                    $dataMetric = 'total'.ucfirst($metric); // e.g. killsVS
 
                     // Handle teamkills inconsistency
                     if ($metric === 'teamkills') {
@@ -100,12 +100,12 @@ 
             // Merge the two arrays together
             foreach ($metrics as $metric) {
                 // Tot up totals
-                $dbMetric = 'total' . ucfirst($metric);
+                $dbMetric = 'total'.ucfirst($metric);
                 $mergedArray['totals'][$metric] = (int) $data[$dbMetric] + (int) $dataArchive[$dbMetric];
                 $results['all']['totals'][$metric] += $mergedArray['totals'][$metric];
 
                 foreach ($factions as $faction) {
-                    $dbMetric = $metric . strtoupper($faction);
+                    $dbMetric = $metric.strtoupper($faction);
                     $mergedArray[$metric][$faction] = (int) $data[$dbMetric] + (int) $dataArchive[$dbMetric];
                     $results['all'][$metric][$faction] += $mergedArray[$metric][$faction];
                 }
@@ -148,7 +148,7 @@ 
             $dataArchive = $this->checkRedis('api', 'classCombat', "{$server}-dataArchive", 'object');
 
             // If data needs a pull
-            if (! $data || ! $dataArchive) {
+            if (!$data || !$dataArchive) {
                 $query = $this->combatRepository->newQuery('single', true);
                 $query->cols([
                         'classID',
@@ -181,8 +181,8 @@ 
             // Typecase into ints and increase totals
             $metrics = ['kills', 'deaths', 'teamkills', 'suicides'];
             foreach ($data as $row) {
-                $row->classID   = (int) $row->classID;
-                $row->server   = (int) $row->server;
+                $row->classID = (int) $row->classID;
+                $row->server = (int) $row->server;
                 $classGroup = $this->findClassGrouping($row->classID);
                 $faction = $this->findClassFaction($row->classID);
 
@@ -201,8 +201,8 @@ 
             }
 
             foreach ($dataArchive as $row) {
-                $row->classID   = (int) $row->classID;
-                $row->server   = (int) $row->server;
+                $row->classID = (int) $row->classID;
+                $row->server = (int) $row->server;
 
                 foreach ($metrics as $metric) {
                     $row->$metric = (int) $row->$metric;

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

Spacing +2 added lines, -2 removed lines

@@ -209,11 +209,11 @@
             $factionAbv = strtoupper($faction);
 
             $sql .= "SUM(CASE WHEN `ResultWinner` = '{$factionAbv}' ";
-            if (! empty($server)) {
+            if (!empty($server)) {
                 $sql .= "AND `ResultServer` IN ({$server}) ";
             }
 
-            if (! empty($zones)) {
+            if (!empty($zones)) {
                 $sql .= "AND `ResultAlertCont` IN ({$zones}) ";
             }
 

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)
     {

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 use League\Fractal\Manager;
 use Ps2alerts\Api\Controller\Endpoint\AbstractEndpointController;
 use Ps2alerts\Api\Repository\AlertRepository;
-use Ps2alerts\Api\Transformer\AlertTotalTransformer;
 use Ps2alerts\Api\Transformer\AlertTransformer;
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Message\ResponseInterface;

Spacing +4 added lines, -4 removed lines

@@ -103,11 +103,11 @@ 
         $limit    = (int) $_GET['limit'];
 
         // Set defaults if not supplied
-        if (empty($offset) || ! is_numeric($offset)) {
+        if (empty($offset) || !is_numeric($offset)) {
             $offset = 0;
         }
 
-        if (empty($limit) || ! is_numeric($limit)) {
+        if (empty($limit) || !is_numeric($limit)) {
             $limit = 50;
         }
 
@@ -173,11 +173,11 @@ 
         $limit  = (int) $_GET['limit'];
 
         // Set defaults if not supplied
-        if (empty($offset) || ! is_numeric($offset)) {
+        if (empty($offset) || !is_numeric($offset)) {
             $offset = 0;
         }
 
-        if (empty($limit) || ! is_numeric($limit)) {
+        if (empty($limit) || !is_numeric($limit)) {
             $limit = 50;
         }
 

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

Unused Use Statements -3 removed lines

@@ -5,10 +5,7 @@
 use League\Fractal\Manager;
 use Ps2alerts\Api\Controller\Endpoint\AbstractEndpointController;
 use Ps2alerts\Api\Repository\AlertRepository;
-use Ps2alerts\Api\Transformer\AlertTotalTransformer;
 use Ps2alerts\Api\Transformer\AlertTransformer;
-use Psr\Http\Message\ServerRequestInterface;
-use Psr\Http\Message\ResponseInterface;
 
 class ContextualDataEndpointController extends AbstractEndpointController
 {

Spacing +1 added lines, -1 removed lines

@@ -22,6 +22,6 @@
     public function __construct(
         Manager          $fractal
     ) {
-        $this->fractal     = $fractal;
+        $this->fractal = $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)
     {

Spacing +4 added lines, -4 removed lines

@@ -79,7 +79,7 @@ 
         }
 
         // Now return the character the outfit injected
-        if (! empty($character['data']['outfit'])) {
+        if (!empty($character['data']['outfit'])) {
             try {
                 $outfit = $this->getOutfit($character['data']['outfit']);
             } catch (CensusErrorException $e) {
@@ -138,7 +138,7 @@ 
         // First, check if we have the character in Redis
         $redisCheck = $this->checkRedis('cache', 'character', $id);
 
-        if (! empty($redisCheck)) {
+        if (!empty($redisCheck)) {
             return $redisCheck;
         }
 
@@ -187,7 +187,7 @@ 
         // First, check if we have the outfit in Redis
         $redisCheck = $this->checkRedis('cache', 'outfit', $id);
 
-        if (! empty($redisCheck)) {
+        if (!empty($redisCheck)) {
             return $redisCheck;
         }
 
@@ -244,7 +244,7 @@ 
         ];
 
         // Loop through each environment and get the first result
-        foreach($environments as $env) {
+        foreach ($environments as $env) {
             $url = "https://census.daybreakgames.com/s:{$config['census_service_id']}/get/{$env}/{$endpoint}";
 
             $req  = $guzzle->request('GET', $url);

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)
     {

Unused Use Statements -3 removed lines

@@ -2,10 +2,7 @@
 
 namespace Ps2alerts\Api\Controller\Endpoint\Leaderboards;
 
-use League\Fractal\Manager;
 use Ps2alerts\Api\Controller\Endpoint\AbstractEndpointController;
-use Ps2alerts\Api\Repository\Metrics\OutfitTotalRepository;
-use Ps2alerts\Api\Repository\Metrics\PlayerTotalRepository;
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Message\ResponseInterface;
 

Indentation +1 added lines, -1 removed lines

@@ -55,7 +55,7 @@
         if ($redis->exists($key)) {
             $data = json_decode($redis->get($key));
 
-             // Ignore if already flagged as being updated
+                // Ignore if already flagged as being updated
             if ($data->beingUpdated == 0) {
                 $data->forceUpdate = 1;
                 $redis->set($key, json_encode($data));

Spacing +1 added lines, -1 removed lines

@@ -83,7 +83,7 @@
 
         $data = [];
 
-        foreach($config['servers'] as $server) {
+        foreach ($config['servers'] as $server) {
             $key = "ps2alerts:api:leaderboards:status:{$server}";
 
             if ($redis->exists($key)) {

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)
     {