Maelstromeous / ps2alerts-api

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/LeaderboardEndpointController.php

Doc Comments +11 added lines, -11 removed lines

@@ -23,7 +23,7 @@ 
     /**
      * Construct
      *
-     * @param League\Fractal\Manager $fractal
+     * @param Manager $fractal
      */
     public function __construct(
         Manager                $fractal,
@@ -43,10 +43,10 @@ 
     /**
      * Get Player Leaderboard
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface $response
      *
-     * @return League\Fractal\Manager
+     * @return ResponseInterface
      */
     public function players(ServerRequestInterface $request, ResponseInterface $response)
     {
@@ -136,10 +136,10 @@ 
     /**
      * Get Outfit Leaderboard
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface $response
      *
-     * @return League\Fractal\Manager
+     * @return ResponseInterface
      */
     public function outfits(ServerRequestInterface $request, ResponseInterface $response)
     {
@@ -210,10 +210,10 @@ 
     /**
      * Get Weapon Leaderboard
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface $response
      *
-     * @return League\Fractal\Manager
+     * @return ResponseInterface
      */
     public function weapons(ServerRequestInterface $request, ResponseInterface $response)
     {
@@ -275,7 +275,7 @@ 
     /**
      * Validates the request variables
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
+     * @param  ServerRequestInterface  $request
      *
      * @return boolean|InvalidArgumentException
      */

Unused Use Statements -1 removed lines

@@ -11,7 +11,6 @@
 use Ps2alerts\Api\Repository\Metrics\OutfitTotalRepository;
 use Ps2alerts\Api\Repository\Metrics\PlayerTotalRepository;
 use Ps2alerts\Api\Repository\Metrics\WeaponTotalRepository;
-use Ps2alerts\Api\Transformer\Leaderboards\LeaderboardUpdatedTransformer;
 use Ps2alerts\Api\Transformer\Leaderboards\OutfitLeaderboardTransformer;
 use Ps2alerts\Api\Transformer\Leaderboards\PlayerLeaderboardTransformer;
 use Ps2alerts\Api\Transformer\Leaderboards\WeaponLeaderboardTransformer;

Spacing +12 added lines, -12 removed lines

@@ -83,7 +83,7 @@ 
             }
         }
 
-        if (! isset($field)) {
+        if (!isset($field)) {
             return $this->errorWrongArgs('Field wasn\'t provided and is required.');
         }
 
@@ -112,7 +112,7 @@ 
 
         // Gets outfit details
         for ($i = 0; $i < $count; $i++) {
-            if (! empty($players[$i]['playerOutfit'])) {
+            if (!empty($players[$i]['playerOutfit'])) {
                 // Gets outfit details
                 try {
                     $outfit = $this->dataEndpoint->getOutfit($players[$i]['playerOutfit']);
@@ -176,7 +176,7 @@ 
             }
         }
 
-        if (! isset($field)) {
+        if (!isset($field)) {
             return $this->errorWrongArgs('Field wasn\'t provided and is required.');
         }
 
@@ -239,7 +239,7 @@ 
             }
         }
 
-        if (! isset($field)) {
+        if (!isset($field)) {
             return $this->errorWrongArgs('Field wasn\'t provided and is required.');
         }
 
@@ -282,19 +282,19 @@ 
     public function validateRequestVars($request)
     {
         try {
-            if (! empty($_GET['field'])) {
+            if (!empty($_GET['field'])) {
                 $this->parseField($_GET['field']);
             }
 
-            if (! empty($_GET['server'])) {
+            if (!empty($_GET['server'])) {
                 $this->parseServer($_GET['server']);
             }
 
-            if (! empty($_GET['limit'])) {
+            if (!empty($_GET['limit'])) {
                 $this->parseOffset($_GET['limit']);
             }
 
-            if (! empty($_GET['offset'])) {
+            if (!empty($_GET['offset'])) {
                 $this->parseOffset($_GET['offset']);
             }
         } catch (InvalidArgumentException $e) {
@@ -320,7 +320,7 @@ 
             'captures'
         ];
 
-        if (! empty($field) && in_array($field, $validFields)) {
+        if (!empty($field) && in_array($field, $validFields)) {
             return $field;
         }
 
@@ -341,7 +341,7 @@ 
             unset($validServers[$key]);
         }
 
-        if (! empty($server) && in_array($server, $validServers)) {
+        if (!empty($server) && in_array($server, $validServers)) {
             return $server;
         }
 
@@ -355,7 +355,7 @@ 
      */
     public function parseLimit($limit)
     {
-        if (! isset($limit) && ! is_numeric($limit)) {
+        if (!isset($limit) && !is_numeric($limit)) {
             throw new InvalidArgumentException("Limit needs to be in numerical format.");
         }
 
@@ -367,7 +367,7 @@ 
      */
     public function parseOffset($offset)
     {
-        if (! isset($offset) && ! is_numeric($offset)) {
+        if (!isset($offset) && !is_numeric($offset)) {
             throw new InvalidArgumentException("Offset needs to be in numerical format.");
         }
 

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

src/Controller/Endpoint/Search/SearchEndpointController.php

Doc Comments +11 added lines, -11 removed lines

@@ -17,11 +17,11 @@ 
     /**
      * Construct
      *
-     * @param League\Fractal\Manager                                   $fractal
-     * @param Ps2alerts\Api\Transformer\Search\OutfitSearchTransformer $outfitSearchTransformer
-     * @param Ps2alerts\Api\Repository\Metrics\OutfitTotalRepository   $outfitTotalRepo
-     * @param Ps2alerts\Api\Transformer\Search\PlayerSearchTransformer $playerSearchTransformer
-     * @param Ps2alerts\Api\Repository\Metrics\PlayerTotalRepository   $playerTotalRepo
+     * @param Manager                                   $fractal
+     * @param OutfitSearchTransformer $outfitSearchTransformer
+     * @param OutfitTotalRepository   $outfitTotalRepo
+     * @param PlayerSearchTransformer $playerSearchTransformer
+     * @param PlayerTotalRepository   $playerTotalRepo
      */
     public function __construct(
         Manager                 $fractal,
@@ -40,11 +40,11 @@ 
     /**
      * Endpoint to return potential players based on search term
      *
-     * @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|null
      */
     public function getPlayersByTerm(ServerRequestInterface $request, ResponseInterface $response, array $args)
     {
@@ -67,11 +67,11 @@ 
     /**
      * Endpoint to return potential players based on search term
      *
-     * @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|null
      */
     public function getOutfitsByTerm(ServerRequestInterface $request, ResponseInterface $response, array $args)
     {

Unused Use Statements -1 removed lines

@@ -4,7 +4,6 @@
 
 use League\Fractal\Manager;
 use Ps2alerts\Api\Controller\Endpoint\AbstractEndpointController;
-use Ps2alerts\Api\Exception\InvalidArgumentException;
 use Ps2alerts\Api\Repository\Metrics\OutfitTotalRepository;
 use Ps2alerts\Api\Repository\Metrics\PlayerTotalRepository;
 use Ps2alerts\Api\Transformer\Search\OutfitSearchTransformer;

Spacing +3 added lines, -3 removed lines

@@ -52,7 +52,7 @@ 
         if ($this->parsePlayerName($args['term'], $response)) {
             $players = $this->searchForPlayer($args['term']);
 
-            if (! empty($players)) {
+            if (!empty($players)) {
                 return $this->respond(
                     'collection',
                     $players,
@@ -81,7 +81,7 @@ 
         if ($this->parseOutfitName($name, $response)) {
             $outfits = $this->searchForOutfit($name);
 
-            if (! empty($outfits)) {
+            if (!empty($outfits)) {
                 return $this->respond(
                     'collection',
                     $outfits,
@@ -199,7 +199,7 @@ 
             return $this->errorWrongArgs('Player ID cannot be longer than 19 characters.');
         }
 
-        if (! is_numeric($id)) {
+        if (!is_numeric($id)) {
             return $this->errorWrongArgs('Player ID must be numeric.');
         }