From 356b2582f3e6a43ecf2607acad4a7fe0b37f659a Mon Sep 17 00:00:00 2001
From: Bot <bot@myigel.name>
Date: Tue, 3 Jan 2017 03:22:48 +0100
Subject: PPHDoc, formatting, fixes, cleanup

---
 includes/model/ShiftsFilter.php | 51 +++++++++++++++++++++++++++++++++++++++--
 1 file changed, 49 insertions(+), 2 deletions(-)

(limited to 'includes/model/ShiftsFilter.php')

diff --git a/includes/model/ShiftsFilter.php b/includes/model/ShiftsFilter.php
index 1e8d49cf..47ef50d7 100644
--- a/includes/model/ShiftsFilter.php
+++ b/includes/model/ShiftsFilter.php
@@ -9,12 +9,11 @@ namespace Engelsystem;
  */
 class ShiftsFilter
 {
-
     /**
      * How long can the time interval be?
+     * 86400 = one day
      */
     const MAX_DURATION = 86400;
-    // one day
 
     /**
      * Shift is completely full.
@@ -33,16 +32,28 @@ class ShiftsFilter
      */
     private $userShiftsAdmin;
 
+    /** @var int[] */
     private $filled = [];
 
+    /** @var int[] */
     private $rooms = [];
 
+    /** @var int[] */
     private $types = [];
 
+    /** @var int unix timestamp */
     private $startTime = null;
 
+    /** @var int unix timestamp */
     private $endTime = null;
 
+    /**
+     * ShiftsFilter constructor.
+     *
+     * @param bool  $user_shifts_admin
+     * @param int[] $rooms
+     * @param int[] $types
+     */
     public function __construct($user_shifts_admin, $rooms, $types)
     {
         $this->user_shifts_admin = $user_shifts_admin;
@@ -58,21 +69,33 @@ class ShiftsFilter
         }
     }
 
+    /**
+     * @return int unix timestamp
+     */
     public function getStartTime()
     {
         return $this->startTime;
     }
 
+    /**
+     * @param int $startTime unix timestamp
+     */
     public function setStartTime($startTime)
     {
         $this->startTime = $startTime;
     }
 
+    /**
+     * @return int unix timestamp
+     */
     public function getEndTime()
     {
         return $this->endTime;
     }
 
+    /**
+     * @param int $endTime unix timestamp
+     */
     public function setEndTime($endTime)
     {
         if ($endTime - $this->startTime > ShiftsFilter::MAX_DURATION) {
@@ -81,6 +104,9 @@ class ShiftsFilter
         $this->endTime = $endTime;
     }
 
+    /**
+     * @return int[]
+     */
     public function getTypes()
     {
         if (count($this->types) == 0) {
@@ -89,11 +115,17 @@ class ShiftsFilter
         return $this->types;
     }
 
+    /**
+     * @param int[] $types
+     */
     public function setTypes($types)
     {
         $this->types = $types;
     }
 
+    /**
+     * @return int[]
+     */
     public function getRooms()
     {
         if (count($this->rooms) == 0) {
@@ -102,26 +134,41 @@ class ShiftsFilter
         return $this->rooms;
     }
 
+    /**
+     * @param int[] $rooms
+     */
     public function setRooms($rooms)
     {
         $this->rooms = $rooms;
     }
 
+    /**
+     * @return bool
+     */
     public function isUserShiftsAdmin()
     {
         return $this->userShiftsAdmin;
     }
 
+    /**
+     * @param bool $userShiftsAdmin
+     */
     public function setUserShiftsAdmin($userShiftsAdmin)
     {
         $this->userShiftsAdmin = $userShiftsAdmin;
     }
 
+    /**
+     * @return int[]
+     */
     public function getFilled()
     {
         return $this->filled;
     }
 
+    /**
+     * @param int[] $filled
+     */
     public function setFilled($filled)
     {
         $this->filled = $filled;
-- 
cgit v1.2.3-54-g00ecf