Maelstromeous / ps2alerts-api

src/Command/ArchiveCommand.php

Doc Comments +5 added lines, -5 removed lines

@@ -32,8 +32,8 @@ 
     /**
      * Execution
      *
-     * @param  Symfony\Component\Console\Input\InputInterface   $input
-     * @param  Symfony\Component\Console\Output\OutputInterface $output
+     * @param  InputInterface   $input
+     * @param  OutputInterface $output
      *
      * @return void
      */
@@ -47,7 +47,7 @@ 
     /**
      * Checks for alerts to be archived then runs routing against said alerts
      *
-     * @param  Symfony\Component\Console\Output\OutputInterface $output
+     * @param  OutputInterface $output
      *
      * @return void
      */
@@ -121,8 +121,8 @@ 
      * Execution of routine
      *
      * @param  array                                            $alert
-     * @param  array                                            $tables
-     * @param  Symfony\Component\Console\Output\OutputInterface $output
+     * @param  string[]                                            $tables
+     * @param  OutputInterface $output
      *
      * @return void
      */

src/Command/DeleteAlertCommand.php

Doc Comments +10 added lines

@@ -49,6 +49,10 @@ 
         }
     }
 
+    /**
+     * @param OutputInterface $output
+     * @param boolean $force
+     */
     public function processAlert($id, $output, $force = null)
     {
         $alert = $this->alertRepo->readSingleById($id, 'primary', true);
@@ -183,6 +187,12 @@ 
         );
     }
 
+    /**
+     * @param string $table
+     * @param string $totalsTable
+     * @param string $filter
+     * @param string[] $groupBy
+     */
     protected function runProcess(
         $id,
         array $cols,

src/Command/LeaderboardCheckCommand.php

Doc Comments +4 added lines

@@ -89,6 +89,10 @@
         }
     }
 
+    /**
+     * @param integer $server
+     * @param OutputInterface $output
+     */
     public function update($server, $output) {
         $output->writeln("Executing update for server: {$server}");
 

src/Command/LeaderboardOutfitsCommand.php

Doc Comments +8 added lines

@@ -120,6 +120,10 @@ 
         }
     }
 
+    /**
+     * @param string $metric
+     * @param integer $server
+     */
     public function markAsBeingUpdated($metric, $server)
     {
         $key = "ps2alerts:api:leaderboards:status:{$metric}:{$server}";
@@ -139,6 +143,10 @@ 
         $this->redis->set($key, json_encode($data));
     }
 
+    /**
+     * @param string $metric
+     * @param integer $server
+     */
     public function markAsComplete($metric, $server)
     {
         $key = "ps2alerts:api:leaderboards:status:{$metric}:{$server}";

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/Contract/HttpMessageAwareTrait.php

Doc Comments +1 added lines, -2 removed lines

@@ -20,7 +20,7 @@ 
     /**
      * Set the http message request
      *
-     * @param \Zend\Diactoros\ServerRequestFactory $obj
+     * @param ServerRequest $obj
      */
     public function setRequest(ServerRequest $obj)
     {
@@ -30,7 +30,6 @@ 
     /**
      * Getthe http message request
      *
-     * @param \Zend\Diactoros\ServerRequestFactory $obj
      */
     public function getRequest()
     {

src/Controller/Endpoint/AbstractEndpointController.php

Doc Comments +8 added lines, -21 removed lines

@@ -98,8 +98,6 @@ 
      * @param  string                                     $kind     The kind of data we wish to return
      * @param  array                                      $data     The data itself
      * @param  \League\Fractal\TransformerAbstract        $callback The transformer class to call
-     * @param  \Psr\Http\Message\ServerRequestInterface  $request  The request itself
-     * @param  \Psr\Http\Message\ResponseInterface $response The response object to eventually call
      *
      * @return \Psr\Http\Message\ResponseInterface
      */
@@ -122,9 +120,8 @@ 
      *
      * @param  array                                      $item        The item to transform
      * @param  \League\Fractal\TransformerAbstract        $transformer The Transformer to pass through to Fractal
-     * @param  \Psr\Http\Message\ResponseInterface $response    The client's response
      *
-     * @return array
+     * @return ResponseInterface
      */
     protected function respondWithItem($item, $transformer)
     {
@@ -152,9 +149,8 @@ 
      *
      * @param  array                                      $collection  The collection to transform
      * @param  \League\Fractal\TransformerAbstract        $transformer The Transformer to pass through to Fractal
-     * @param  \Psr\Http\Message\ResponseInterface $response    The client's response
      *
-     * @return array
+     * @return ResponseInterface
      */
     protected function respondWithCollection($collection, $transformer)
     {
@@ -180,7 +176,6 @@ 
     /**
      * The final step where the formatted array is now sent back as a response in JSON form
      *
-     * @param  \Psr\Http\Message\ResponseInterface $response
      * @param  array                                      $array
      *
      * @return \Psr\Http\Message\ResponseInterface
@@ -210,11 +205,10 @@ 
     /**
      * Responds gracefully with an error.
      *
-     * @param  \Psr\Http\Message\ResponseInterface $response
      * @param  string                                     $message   Response message to put in the error
      * @param  int                                        $errorCode Error code to set
      *
-     * @return array
+     * @return ResponseInterface
      */
     protected function respondWithError($message, $errorCode)
     {
@@ -238,10 +232,9 @@ 
     /**
      * Generates a response with a 404 HTTP error and a given message.
      *
-     * @param  \Psr\Http\Message\ResponseInterface $response
      * @param  string                                     $message
      *
-     * @return void
+     * @return ResponseInterface
      */
     public function errorEmpty($message = 'No data / Empty')
     {
@@ -252,10 +245,9 @@ 
     /**
      * Generates a Response with a 403 HTTP header and a given message.
      *
-     * @param  \Psr\Http\Message\ResponseInterface $response
      * @param  string                                     $message
      *
-     * @return void
+     * @return ResponseInterface
      */
     public function errorForbidden($message = 'Forbidden')
     {
@@ -266,10 +258,9 @@ 
     /**
      * Generates a Response with a 500 HTTP header and a given message.
      *
-     * @param  \Psr\Http\Message\ResponseInterface $response
      * @param  string                                     $message
      *
-     * @return void
+     * @return ResponseInterface
      */
     public function errorInternalError($message = 'Internal Error')
     {
@@ -280,10 +271,9 @@ 
     /**
      * Generates a Response with a 404 HTTP header and a given message.
      *
-     * @param  \Psr\Http\Message\ResponseInterface $response
      * @param  string                                     $message
      *
-     * @return void
+     * @return ResponseInterface
      */
     public function errorNotFound($message = 'Resource Not Found')
     {
@@ -294,10 +284,9 @@ 
     /**
      * Generates a Response with a 401 HTTP header and a given message.
      *
-     * @param  \Psr\Http\Message\ResponseInterface $response
      * @param  string                                     $message
      *
-     * @return void
+     * @return ResponseInterface
      */
     public function errorUnauthorized($message = 'Unauthorized')
     {
@@ -308,7 +297,6 @@ 
     /**
      * Generates a Response with a 400 HTTP header and a given message.
      *
-     * @param \Psr\Http\Message\ResponseInterface $response
      * @param string                                     $message
      *
      * @return \Psr\Http\Message\ResponseInterface
@@ -322,7 +310,6 @@ 
     /**
      * Reads any requested includes and adds them to the item / collection
      *
-     * @param  Psr\Http\Message\ServerRequestInterface $request
      *
      * @return void
      */

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