xoco70 / laravel-tournaments

src/TreeController.php

Doc Comments +4 added lines, -1 removed lines

@@ -37,7 +37,7 @@ 
      *
      * @param Request $request
      *
-     * @return \Illuminate\Http\Response|string
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function store(Request $request, $championshipId)
     {
@@ -137,6 +137,9 @@ 
         return back();
     }
 
+    /**
+     * @param integer $numFighter
+     */
     public function getWinnerId($fighters, $scores, $numFighter)
     {
         return $scores[$numFighter] != null ? $fighters[$numFighter] : null;

src/TreeGen/SingleEliminationTreeGen.php

Doc Comments +2 added lines, -2 removed lines

@@ -57,7 +57,7 @@ 
     /**
      * Create empty groups after round 1.
      *
-     * @param $numFighters
+     * @param integer $numFighters
      */
     protected function pushEmptyGroupsToTree($numFighters)
     {
@@ -155,7 +155,7 @@ 
 
     /**
      * @param Collection $usersByArea
-     * @param $round
+     * @param integer $round
      */
     public function generateGroupsForRound(Collection $usersByArea, $round)
     {

src/TreeGen/TreeGen.php

Doc Comments +13 added lines, -7 removed lines

@@ -22,8 +22,14 @@ 
     abstract protected function generateFights();
 
 
+    /**
+     * @param string|null $fighterToUpdate
+     */
     abstract protected function addFighterToGroup(FightersGroup $group, $fighter, $fighterToUpdate);
 
+    /**
+     * @return Collection
+     */
     abstract protected function getByeGroup($fighters);
 
     abstract protected function getNumRounds($fightersCount);
@@ -61,7 +67,7 @@ 
     /**
      * Get the biggest entity group.
      *
-     * @param $userGroups
+     * @param Collection $userGroups
      *
      * @return int
      */
@@ -130,7 +136,7 @@ 
     /**
      * Repart BYE in the tree,.
      *
-     * @param $fighterGroups
+     * @param Collection $fighterGroups
      * @param int $max
      *
      * @return Collection
@@ -288,7 +294,7 @@ 
     /**
      * Attach a parent to every child for nestedSet Navigation.
      *
-     * @param $numFightersElim
+     * @param integer $numFightersElim
      */
     protected function addParentToChildren($numFightersElim)
     {
@@ -312,8 +318,8 @@ 
 
     /**
      * @param Collection $fighters
-     * @param $frequency
-     * @param $sizeGroupBy
+     * @param integer $frequency
+     * @param integer $sizeGroupBy
      * @param $bye
      *
      * @return Collection
@@ -338,8 +344,8 @@ 
     /**
      * @param $frequency
      * @param $sizeGroupBy
-     * @param $count
-     * @param $byeCount
+     * @param integer $count
+     * @param integer $byeCount
      *
      * @return bool
      */

src/TreeGen/PlayOffTreeGen.php

Doc Comments +4 added lines, -1 removed lines

@@ -29,7 +29,7 @@ 
      *
      * @param $fightersByEntity
      *
-     * @return mixed
+     * @return Collection
      */
     protected function chunkAndShuffle(Collection $fightersByEntity)
     {
@@ -104,6 +104,9 @@ 
         $this->generateGroupsForRound($fighters, 1);
     }
 
+    /**
+     * @param integer $round
+     */
     protected function generateGroupsForRound(Collection $fightersByArea, $round)
     {
         $fightersId = $fightersByArea->pluck('id');

src/Models/Competitor.php

Doc Comments +1 added lines, -1 removed lines

@@ -19,7 +19,7 @@
     /**
      * Get User from Competitor.
      *
-     * @return mixed
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
      */
     public function user()
     {

src/Models/Fight.php

Doc Comments +2 added lines, -1 removed lines

@@ -41,7 +41,7 @@ 
     }
 
     /**
-     * @param FightersGroup|null $group
+     * @param FightersGroup $group
      *
      * @return Collection
      */
@@ -151,6 +151,7 @@ 
     }
 
     /**
+     * @param boolean $default
      * @return bool
      */
     public function shouldBeInFightList($default)

src/Models/Team.php

Doc Comments +3 added lines

@@ -31,6 +31,9 @@
         return $this->name;
     }
 
+    /**
+     * @param string $attr
+     */
     public function hasAttribute($attr)
     {
         return array_key_exists($attr, $this->attributes);