Maelstromeous / ps2alerts-api

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

src/Transformer/DataTransformer.php

Doc Comments -1 removed lines

@@ -57,7 +57,6 @@
     /**
      * The tranform method required by Fractal to parse the data and return proper typing and fields.
      *
-     * @param  array $data Data to transform
      *
      * @return array
      */

src/Transformer/Profiles/OutfitProfileTransformer.php

Doc Comments +3 added lines

@@ -219,6 +219,9 @@
         return $players;
     }
 
+    /**
+     * @param integer $offset
+     */
     public function getOutfitMembers($data, $offset)
     {
         $client = $this->getHttpClientDriver();

src/Transformer/Profiles/PlayerProfileTransformer.php

Doc Comments +3 added lines, -4 removed lines

@@ -72,7 +72,7 @@ 
      *
      * @param  array $data
      *
-     * @return \League\Fractal\Resource\Collection
+     * @return \League\Fractal\Resource\Item
      */
     public function includeCensus($data)
     {
@@ -144,9 +144,8 @@ 
     /**
      * Gets Metrics for a player
      *
-     * @param  array $player
      *
-     * @return array
+     * @return \League\Fractal\Resource\Item
      */
     public function includeMetrics($data)
     {
@@ -179,7 +178,7 @@ 
      *
      * @param  array $data
      *
-     * @return \League\Fractal\Resource\Collection
+     * @return \League\Fractal\Resource\Item
      */
     public function includeOutfit($data)
     {

src/Command/ArchiveCommand.php

Doc Comments +2 added lines, -2 removed lines

@@ -122,8 +122,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 +11 added lines, -5 removed lines

@@ -115,7 +115,7 @@ 
     /**
      * Processes players for alert
      * @param  string $id Alert ID
-     * @return void
+     * @return integer
      */
     protected function processPlayers($id)
     {
@@ -149,7 +149,7 @@ 
     /**
      * Processes outfits for alert
      * @param  string $id Alert ID
-     * @return void
+     * @return integer
      */
     protected function processOutfits($id)
     {
@@ -181,7 +181,7 @@ 
     /**
      * Processes XPs for alert
      * @param  string $id Alert ID
-     * @return void
+     * @return integer
      */
     protected function processXP($id)
     {
@@ -208,11 +208,11 @@ 
     /**
      * Executes the process based on inputs
      * @param  string $id          Alert ID
-     * @param  array  $cols        Columns to look for
+     * @param  string[]  $cols        Columns to look for
      * @param  string $table       Table to look for
      * @param  string $totalsTable Table total to update if applicable
      * @param  string $filter      Column to filter on
-     * @param  array  $fields      Fields to summarize
+     * @param  string[]  $fields      Fields to summarize
      * @param  array  $groupBy     Fields to group by
      * @return int
      */
@@ -270,6 +270,9 @@ 
         return $count;
     }
 
+    /**
+     * @param string $id
+     */
     protected function deleteAllFromTables(array $tables, $id, OutputInterface $output)
     {
         foreach ($tables as $table) {
@@ -288,6 +291,9 @@ 
         }
     }
 
+    /**
+     * @param string $id
+     */
     protected function deleteAlert($id)
     {
         $delete = $this->auraFactory->newDelete();