BurningFlipside / VolunteerSystem

api/v1/class.VolunteerAPI.php

Doc Comments +3 added lines

@@ -5,6 +5,9 @@
     protected $isAdmin = null;
     protected $isLead = null;
 
+    /**
+     * @param string $dataTableName
+     */
     public function __construct($dataTableName, $idField = '_id')
     {
         parent::__construct('fvs', $dataTableName, $idField);

api/v1/class.DepartmentAPI.php

Doc Comments +6 added lines

@@ -109,6 +109,9 @@ 
         return $response->withJson($shifts);
     }
 
+    /**
+     * @param string $table
+     */
     protected function createEntityForDepartment($request, $response, $args, $table)
     {
         $deptId = $args['dept'];
@@ -212,6 +215,9 @@ 
         return $response;
     }
 
+    /**
+     * @param string $type
+     */
     public function generateGridSchedule($dept, $shifts, $response, $type)
     {
         $ss = new \Schedules\GridSchedule($dept, $shifts);

api/v1/class.Processor.php

Doc Comments +9 added lines

@@ -1,6 +1,9 @@ 
 <?php
 trait Processor
 {
+    /**
+     * @param string $certType
+     */
     protected function certCheck($requirements, $certs, $certType)
     {
         if(isset($requirements[$certType]) && $requirements[$certType])
@@ -12,6 +15,9 @@ 
 
     protected abstract function isVolunteerAdmin($request);
 
+    /**
+     * @param VolunteerProfile|null $user
+     */
     public function canUserDoRole($user, $role)
     {
         if($role['publicly_visible'] === true)
@@ -152,6 +158,9 @@ 
         return !in_array($deptId, $privateDepts);
     }
 
+    /**
+     * @param VolunteerShift $shift
+     */
     protected function doShiftTimeChecks($shift, $entry)
     {
         $now = new DateTime();

app/Schedules/class.GridSchedule.php

Doc Comments +17 added lines

@@ -45,6 +45,11 @@ 
         return ($hour - 12).'p';
     }
 
+    /**
+     * @param integer $hourCount
+     * @param integer $rowCount
+     * @param \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $sheat
+     */
     protected function grayOutUnused($hourCount, $rowCount, $sheat)
     {
         for($i = 0; $i < $hourCount; $i++)
@@ -74,6 +79,9 @@ 
         }
     }
 
+    /**
+     * @param double $hourCount
+     */
     protected function getHoursArrays($hour, $hourCount)
     {
         $simpleHours = array();
@@ -91,12 +99,21 @@ 
         return array($simpleHours, $militaryHours);
     }
 
+    /**
+     * @param \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $sheat
+     * @param double $col
+     * @param integer $row
+     */
     protected function createShiftCell($sheat, $col, $row, $shift)
     {
         $sheat->mergeCellsByColumnAndRow($col, $row, $col+$shift['length']-1, $row);
         $this->setShiftNameInCell($sheat, $col, $row, $shift);
     }
 
+    /**
+     * @param double $col
+     * @param \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $sheat
+     */
     protected function getRowForShift($roleID, $rows, $col, $sheat)
     {
         $firstRow = array_search($roleID, $rows);